1.3.0, document env() lookups

ljharb · May 13, 2013 · 041c5da · 041c5da
1 parent 16139f5
commit 041c5da
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
  "name" : "shell-quote",
- "version" : "1.2.0",
+ "version" : "1.3.0",
  "description" : "quote and parse shell commands",
  "main" : "index.js",
  "directories" : {

diff --git a/readme.markdown b/readme.markdown
@@ -81,6 +81,11 @@ Return an array of arguments from the quoted string `cmd`.
 Interpolate embedded bash-style `$VARNAME` and `${VARNAME}` variables with
 the `env` object which like bash will replace undefined variables with `""`.
 
+`env` is usually an object but it can also be a function to perform lookups.
+When `env(key)` returns a string, its result will be output just like `env[key]`
+would. When `env(key)` returns an object, it will be inserted into the result
+array like the operator objects.
+
 When a bash operator is encountered, the element in the array with be an object
 with an `"op"` key set to the operator string. For example: