readme with examples

README.markdown

@@ -0,0 +1,70 @@
+shell-quote
+===========
+
+Parse and quote shell commands.
+
+example
+=======
+
+quote
+-----
+
+``` js
+var quote = require('shell-quote').quote;
+var s = quote([ 'a', 'b c d', '$f', '"g"' ]);
+console.log(s);
+```
+
+output
+
+```
+a 'b c d' \$f '"g"'
+```
+
+parse
+-----
+
+``` js`
+var parse = require('shell-quote').parse;
+var xs = parse('a "b c" \\$def \'it\\\'s great\'');
+console.dir(xs);
+```
+
+output
+
+```
+[ 'a', 'b c', '\\$def', 'it\'s great' ]
+```
+
+methods
+=======
+
+``` js
+var quote = require('shell-quote').quote;
+var parse = require('shell-quote').parse;
+```
+
+quote(args)
+-----------
+
+Return a quoted string for the array `args` suitable for using in shell
+commands.
+
+parse(cmd)
+----------
+
+Return an array of arguments from the quoted string `cmd`.
+
+install
+=======
+
+With [npm](http://npmjs.org) do:
+
+```
+npm install shell-quote
+```
+
+license
+=======
+
+MIT

example/parse.js

@@ -0,0 +1,3 @@
+var parse = require('../').parse;
+var xs = parse('a "b c" \\$def \'it\\\'s great\'');
+console.dir(xs);

example/quote.js

@@ -0,0 +1,3 @@
+var quote = require('../').quote;
+var s = quote([ 'a', 'b c d', '$f', '"g"' ]);
+console.log(s);