Skip to content

Fix up bitrotted links #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
maghoff wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix up bitrotted links #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a0bfa3f
Fix up bitrotted links and restructure documentation to reduce potent…
maghoff Jun 3, 2016
1bb6e25
Update missed link
maghoff Jun 3, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
# 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]
[![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
Expand All @@ -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*() {
Expand All @@ -43,30 +52,21 @@ 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

```sh
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)