From a0bfa3f9f684fb3e61b76ba59995e09ab4db495f Mon Sep 17 00:00:00 2001 From: Magnus Hoff Date: Fri, 3 Jun 2016 22:23:14 +0200 Subject: [PATCH 1/2] Fix up bitrotted links and restructure documentation to reduce potential for link rot --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index ffdc6b3..804b025 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,15 @@ Pipe ES6 Generators through Node.js [Streams][12]. [![dependencies][5]][6] [![devDependencies][7]][8] +[1]: https://badge.fury.io/js/stream-generators.svg +[2]: https://badge.fury.io/js/stream-generators +[3]: https://api.travis-ci.org/mimetnet/node-stream-generators.svg +[4]: https://travis-ci.org/mimetnet/node-stream-generators +[5]: https://david-dm.org/mimetnet/node-stream-generators.svg +[6]: https://david-dm.org/mimetnet/node-stream-generators +[7]: https://david-dm.org/mimetnet/node-stream-generators/dev-status.svg?#info=devDependencies +[8]: https://david-dm.org/mimetnet/node-stream-generators/#info=devDependencies + ## Usage ```js @@ -31,8 +40,8 @@ streamify(gen).pipe(process.stdout); ## API #### streamify(function*) -The result of [require][13] is a 'function()' that when invoked, will return a -[Readable][11] [Stream][12]. +The result of [require][require] is a `function()` that when invoked, will +return a [Readable][Readable] [Stream][Stream]. ``` var generator = function*() { @@ -43,9 +52,14 @@ var streamify = require('stream-generators'); var readable = streamify(generator); ``` -This [Stream][12] will [push][14] each element from the generator into the -[piped][15] array. +This [Stream][Stream] will [push][push] each element from the generator into +the [piped][pipe] array. +[Readable]: http://nodejs.org/api/stream.html#stream_class_stream_readable +[Stream]: http://nodejs.org/api/stream.html#stream_stream +[require]: http://nodejs.org/api/globals.html#globals_require +[push]: https://nodejs.org/api/stream.html#stream_readable_push_chunk_encoding +[pipe]: https://nodejs.org/api/stream.html#stream_readable_pipe_destination_options ## Install @@ -53,20 +67,6 @@ This [Stream][12] will [push][14] each element from the generator into the npm install stream-generators ``` - [1]: https://badge.fury.io/js/stream-generators.svg - [2]: https://badge.fury.io/js/stream-generators - [3]: https://api.travis-ci.org/mimetnet/node-stream-generators.svg - [4]: https://travis-ci.org/mimetnet/node-stream-generators - [5]: https://david-dm.org/mimetnet/node-stream-generators.svg - [6]: https://david-dm.org/mimetnet/node-stream-generators - [7]: https://david-dm.org/mimetnet/node-stream-generators/dev-status.svg?#info=devDependencies - [8]: https://david-dm.org/mimetnet/node-stream-generators/#info=devDependencies - [9]: http://nodejs.org/api/stream.html#stream_class_stream_readable - [10]: http://nodejs.org/api/stream.html#stream_stream - [11]: http://nodejs.org/api/globals.html#globals_require - [12]: https://nodejs.org/api/stream.html#stream_readable_push_chunk_encoding - [13]: https://nodejs.org/api/stream.html#stream_readable_pipe_destination_options - ## License [MIT License](https://github.com/mimetnet/node-stream-generators/blob/master/LICENSE) From 1bb6e25d144dbb6ce39ad06ecf783b21d59e69b4 Mon Sep 17 00:00:00 2001 From: Magnus Hoff Date: Fri, 3 Jun 2016 23:18:53 +0200 Subject: [PATCH 2/2] Update missed link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 804b025..a569805 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # stream-generators -Pipe ES6 Generators through Node.js [Streams][12]. +Pipe ES6 Generators through Node.js [Streams][Stream]. [![npm version][1]][2] [![build status][3]][4]