[Pkg-javascript-commits] [node-stream-splicer] 42/71: document .get() and nested streams

[Bastien Roucariès]

This is an automated email from the git hooks/post-receive script.

rouca pushed a commit to branch master
in repository node-stream-splicer.

commit aafb7db8f4566f4f3773b2cb183cd41538fcdf9a
Author: James Halliday <mail at substack.net>
Date:   Mon Jun 9 19:37:12 2014 -0700

    document .get() and nested streams
---
 readme.markdown | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/readme.markdown b/readme.markdown
index 2e7bdf3..16003c8 100644
--- a/readme.markdown
+++ b/readme.markdown
@@ -85,6 +85,10 @@ a.pipe(b).pipe(c).pipe(d)
 
 Input will get written into `a`. Output will be read from `d`.
 
+If any of the elements in `streams` are arrays, they will be converted into
+nested pipelines. This is useful if you want to expose a hookable pipeline with
+grouped insertion points.
+
 ## var pipeline = splicer.obj(streams, opts)
 
 Create a `pipeline` with `opts.objectMode` set to true for convenience.
@@ -112,6 +116,10 @@ Unshift one or more streams to the begining of the pipeline.
 
 Shift a stream from the begining of the pipeline.
 
+## var stream = pipeline.get(index)
+
+Return the stream at index `index`.
+
 # install
 
 With [npm](https://npmjs.org) do:

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-stream-splicer.git