Skip to content

Commit

Permalink
Update readme, version to 0.5
Browse files Browse the repository at this point in the history
  • Loading branch information
tilfin committed Sep 20, 2016
1 parent 6755d6f commit de4ea49
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Creating promisified stream pipeline for Node.js

* Streams are pipelined and it resolves when last stream have finished.
* If an error occurred at any stream, it rejects with the error.
* If last stream is not Writable, it pushes auto-generated writer to streams.
* Last stream must raise `finish` event. It doesn't support process.stdout.
* If last stream is Readable or Transform, it appends auto-generated writer to streams.
* Last stream must raise `finish` event. `process.stdout` doesn't raise it.

## Install

Expand All @@ -25,7 +25,7 @@ $ npm install -save promised-lifestream

**PromisedLifestream(streams, [options])**

* `streams` `<Array<Stream>>` streams composes pipeline
* `streams` `<Array<Stream>>` streams composes pipeline. The first stream must be Readable. The second and any later stream must be Writable. The last stream can be Transform.
* `options` `<Object>`
* `needResult` `<Boolean>` Whether the last stream result is resolved or not. Defaults to false

Expand Down
8 changes: 5 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
{
"name": "promised-lifestream",
"version": "0.2.0",
"version": "0.5.0",
"description": "Creating promisified stream pipeline",
"main": "lib/main.js",
"scripts": {
"test": "mocha"
"test": "mocha",
"coverage": "./node_modules/.bin/istanbul cover _mocha -r test/*.test.js"
},
"repository": {
"type": "git",
"url": "git+https://github.com/tilfin/promised-lifestream.git"
},
"keywords": [
"Promise",
"stream"
"stream",
"streams"
],
"author": "Toshimitsu Takahashi",
"license": "MIT",
Expand Down

0 comments on commit de4ea49

Please sign in to comment.