env parse example

ljharb · Apr 15, 2013 · 5757c42 · 5757c42
1 parent 24106f5
commit 5757c42
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/example/env.js b/example/env.js
@@ -0,0 +1,3 @@
+var parse = require('../').parse;
+var xs = parse('beep --boop="$PWD"', { PWD: '/home/robot' });
+console.dir(xs);
diff --git a/readme.markdown b/readme.markdown
@@ -22,7 +22,7 @@ a 'b c d' \$f '"g"'
 
 ## parse
 
-``` js`
+``` js
 var parse = require('shell-quote').parse;
 var xs = parse('a "b c" \\$def \'it\\\'s great\'');
 console.dir(xs);
@@ -34,6 +34,20 @@ output
 [ 'a', 'b c', '\\$def', 'it\'s great' ]
 ```
 
+## parse with an environment variable
+
+``` js
+var parse = require('shell-quote').parse;
+var xs = parse('beep --boop="$PWD"', { PWD: '/home/robot' });
+console.dir(xs);
+```
+
+output
+
+```
+[ 'beep', '--boop=/home/robot' ]
+```
+
 # methods
 
 ``` js