[Pkg-javascript-commits] [node-module-deps] 07/444: 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-module-deps.

commit 9e767914b694ac60e50183e232588413e3d638bd
Author: James Halliday <mail at substack.net>
Date:   Mon Feb 11 06:58:08 2013 -0800

    docs
---
 cmd.js          |  4 +--
 example/deps.js |  4 +--
 readme.markdown | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 80 insertions(+), 4 deletions(-)

diff --git a/cmd.js b/cmd.js
index 6cc0411..25e3187 100755
--- a/cmd.js
+++ b/cmd.js
@@ -1,8 +1,8 @@
 #!/usr/bin/env node
-var parser = require('./');
+var mdeps = require('./');
 var JSONStream = require('JSONStream');
 
 var stringify = JSONStream.stringify();
 stringify.pipe(process.stdout);
 
-parser(process.argv.slice(2)).pipe(stringify);
+mdeps(process.argv.slice(2)).pipe(stringify);
diff --git a/example/deps.js b/example/deps.js
index 846a502..1e0cca4 100644
--- a/example/deps.js
+++ b/example/deps.js
@@ -1,8 +1,8 @@
-var parser = require('../');
+var mdeps = require('../');
 var JSONStream = require('JSONStream');
 
 var stringify = JSONStream.stringify();
 stringify.pipe(process.stdout);
 
 var file = __dirname + '/files/main.js';
-parser(file).pipe(stringify);
+mdeps(file).pipe(stringify);
diff --git a/readme.markdown b/readme.markdown
new file mode 100644
index 0000000..effd333
--- /dev/null
+++ b/readme.markdown
@@ -0,0 +1,76 @@
+# module-deps
+
+walk the dependency graph to generate json output that can be fed into
+[browser-pack](https://github.com/substack/browser-build)
+
+# example
+
+``` js
+var mdeps = require('module-deps');
+var JSONStream = require('JSONStream');
+
+var stringify = JSONStream.stringify();
+stringify.pipe(process.stdout);
+
+var file = __dirname + '/files/main.js';
+mdeps(file).pipe(stringify);
+```
+
+output:
+
+```
+$ node example/deps.js
+[
+{"id":"/home/substack/projects/module-deps/example/files/main.js","source":"var foo = require('./foo');\nconsole.log('main: ' + foo(5));\n","entry":true,"deps":{"./foo":"/home/substack/projects/module-deps/example/files/foo.js"}}
+,
+{"id":"/home/substack/projects/module-deps/example/files/foo.js","source":"var bar = require('./bar');\n\nmodule.exports = function (n) {\n    return n * 111 + bar(n);\n};\n","deps":{"./bar":"/home/substack/projects/module-deps/example/files/bar.js"}}
+,
+{"id":"/home/substack/projects/module-deps/example/files/bar.js","source":"module.exports = function (n) {\n    return n * 100;\n};\n","deps":{}}
+]
+```
+
+and you can feed this json data into
+[browser-pack](https://github.com/substack/browser-build):
+
+```
+$ node example/deps.js | browser-pack | node
+main: 1055
+```
+
+# usage
+
+```
+usage: module-deps [files]
+
+  generate json output from each entry file
+
+```
+
+# methods
+
+``` js
+var mdeps = require('module-deps')
+```
+
+## mdeps(files)
+
+Return a readable stream of javascript objects from an array of filenames
+`files`.
+
+# install
+
+With [npm](http://npmjs.org), to get the module do:
+
+```
+npm install module-deps
+```
+
+and to get the `module-deps` command do:
+
+```
+npm install -g module-deps
+```
+
+# license
+
+MIT

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