Merge pull request #132 from LongLiveCHIEF/cli-doc-clarification

arg usage doc improvements
mozilla · Mar 15, 2016 · c6c8cfb · c6c8cfb
2 parents 2b8610b + 9f0c2e8
commit c6c8cfb
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -71,6 +71,8 @@ module.exports = conf;
 
 ### Usage
 
+Example `server.js`:
+
 ```javascript
 var http = require('http');
 var conf = require('./config.js');
@@ -87,6 +89,14 @@ server.listen(conf.get('port'), conf.get('ip'), function(x) {
 });
 ```
 
+To launch your example server, and set a port:
+
+```bash
+node ./server.js --port 8080
+```
+
+*Note*: arguments *must* be supplied with the double-hyphen `--arg`. (Single hypen's are not supported at this time.)
+
 ## The Schema
 
 A configuration module could look like this: