[Pkg-javascript-commits] [node-deps-sort] 03/79: docs

[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-deps-sort.

commit 8db504634153b17598238a2cfb1dbacaf66e938c
Author: James Halliday <mail at substack.net>
Date:   Mon Jul 8 23:17:31 2013 -0700

    docs
---
 readme.markdown | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 63 insertions(+), 2 deletions(-)

diff --git a/readme.markdown b/readme.markdown
index bf673c3..5933bb5 100644
--- a/readme.markdown
+++ b/readme.markdown
@@ -1,5 +1,66 @@
 # deps-sort
 
-sort [module-deps](https://npmjs.org/package/module-deps) rows for deterministic
-output
+sort [module-deps](https://npmjs.org/package/module-deps) output for deterministic
+browserify bundles
 
+# example
+
+## command-line
+
+```
+$ for((i=0;i<5;i++)); do module-deps main.js | deps-sort | browser-pack | md5sum; done
+e9e630de2c62953140357db0444c3c3a  -
+e9e630de2c62953140357db0444c3c3a  -
+e9e630de2c62953140357db0444c3c3a  -
+e9e630de2c62953140357db0444c3c3a  -
+e9e630de2c62953140357db0444c3c3a  -
+```
+
+or using `browserify --deps` on a [voxeljs](http://voxeljs.com/) project:
+
+```
+$ for((i=0;i<5;i++)); do browserify --deps browser.js | deps-sort | browser-pack | md5sum; done
+fb418c74b53ba2e4cef7d01808b848e6  -
+fb418c74b53ba2e4cef7d01808b848e6  -
+fb418c74b53ba2e4cef7d01808b848e6  -
+fb418c74b53ba2e4cef7d01808b848e6  -
+fb418c74b53ba2e4cef7d01808b848e6  -
+```
+
+## api
+
+To use this module programmatically, write streaming object data and read
+streaming object data:
+
+``` js
+var sort = require('../')();
+var JSONStream = require('JSONStream');
+var parse = JSONStream.parse([ true ]);
+var stringify = JSONStream.stringify();
+
+process.stdin.pipe(parse).pipe(sort).pipe(stringify).pipe(process.stdout);
+```
+
+# methods
+
+``` js
+var depsSort = require('deps-sort');
+```
+
+## var stream = depsSort()
+
+Return a new through `stream` that should get written
+[module-deps](https://npmjs.org/package/module-deps) objects and will output
+sorted objects.
+
+# install
+
+With [npm](https://npmjs.org) do:
+
+```
+npm install deps-sort
+```
+
+# license
+
+MIT

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