add env docs

tj · Jun 28, 2012 · 584d873 · 584d873
1 parent b3278fd
commit 584d873
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/Readme.md b/Readme.md
@@ -111,6 +111,17 @@ yields:
 
 ### eson.env([prefix])
 
+  Allow environment variables to define config values. If you have the following:
+
+```js
+{
+  "upload path": "/data/uploads"
+}
+```
+
+  You could then export `UPLOAD_PATH=/tmp` to change this value. Optionally when
+  a `prefix` is given such as "MYAPP_" then you must prefix such as `MYAPP_UPLOAD_PATH=/tmp`.
+
 ### eson.replace(str, val)
 
   The replace plugin allows you to replace arbitrary substrings, useful