Skip to content
Browse files

update docs

  • Loading branch information...
1 parent 14f8e15 commit 9c0e77c4cd162d240c44bc0e49c71306d4e94115 @dominictarr committed Jul 30, 2012
Showing with 28 additions and 0 deletions.
  1. +28 −0 readme.markdown
View
28 readme.markdown
@@ -2,5 +2,33 @@
An easy way to create a `readable Stream`.
+## from(function getChunk(count, next))
+
+from takes a `getChunk` function and returns a stream.
+
+`getChunk` is called again and again, after each time the user calls `next()`,
+until the user emits `'end'`
+
+if `pause()` is called, the `getChunk` won't be called again untill `resume()` is called.
+
+
+``` js
+var from = require('from')
+
+var stream =
+ from(function getChunk(count, next) {
+ //do some sort of data
+ this.emit('data', whatever)
+
+ if(itsOver)
+ this.emit('end')
+
+ //ready to handle the next chunk
+ next()
+ //or, if it's sync:
+ return true
+ })
+```
+
## License
MIT / Apache2

0 comments on commit 9c0e77c

Please sign in to comment.
Something went wrong with that request. Please try again.