Update -h examples, fix reference to streams

Author: tmcw

README.md

@@ -62,26 +62,28 @@ $ documentation -h
 Usage: documentation <command> [options]
 
 Options:
-  -f, --format   output format, of [json, md, html]            [default: "json"]
-  --lint         check output for common style and uniformity mistakes          
-  -t, --theme    specify a theme: this must be a valid theme module             
-  -p, --private  generate documentation tagged as private                       
-  --name         project name. by default, inferred from package.json           
-  --version      project version. by default, inferred from package.json        
-  --shallow      shallow mode turns off dependency resolution, only processing
-                 the specified files (or the main script specified in
-                 package.json)                                  [default: false]
-  --polyglot     polyglot mode turns off dependency resolution and enables
-                 multi-language support. use this to document c++               
-  -g, --github   infer links to github in documentation                         
-  -o, --output   output location. omit for stdout, otherwise is a filename for
-                 single-file outputs and a directory name for multi-file
-                 outputs like html                           [default: "stdout"]
-  -c, --config   configuration file. an array defining explicit sort order      
-  -h, --help     Show help                                                      
+  --lint             check output for common style and uniformity mistakes
+                                                                       [boolean]
+  -t, --theme        specify a theme: this must be a valid theme module
+  -p, --private      generate documentation tagged as private          [boolean]
+  --version          Show version number                               [boolean]
+  --name             project name. by default, inferred from package.json
+  --project-version  project version. by default, inferred from package.json
+  --shallow          shallow mode turns off dependency resolution, only
+                     processing the specified files (or the main script
+                     specified in package.json)       [boolean] [default: false]
+  --polyglot         polyglot mode turns off dependency resolution and enables
+                     multi-language support. use this to document c++  [boolean]
+  -g, --github       infer links to github in documentation            [boolean]
+  -o, --output       output location. omit for stdout, otherwise is a filename
+                     for single-file outputs and a directory name for multi-file
+                     outputs like html                       [default: "stdout"]
+  -c, --config       configuration file. an array defining explicit sort order
+  -h, --help         Show help                                         [boolean]
+  -f, --format                 [choices: "json", "md", "html"] [default: "json"]
 
 Examples:
-  documentation foo.js    parse documentation in a given file
+  documentation foo.js  parse documentation in a given file
 ```
 
 ## [Contributing](CONTRIBUTING.md)

docs/FAQ.md

@@ -35,7 +35,6 @@ documentation.
 * Beatiful defaults for HTML & Markdown output
 * Supports CommonJS `require()` syntax so that node modules can be documented
   by giving their `main` file
-* Expresses source transformations as chainable transform streams
 * Heavily documented internally: all public and private functions in `documentation`
   are documented. [JSDoc is not well documented internally](https://github.com/jsdoc3/jsdoc/issues/839).
 * Robust ES6 support
@@ -46,8 +45,6 @@ documentation.
   tasks: separates concerns so that we can focus on a robust solution
 * Customization points like plugins & templates are heavily documented and
   made to be flexible
-* Uses streams & [vinyl](https://github.com/wearefractal/vinyl) to make
-  output configurable and stdout-friendly.
 
 ## Why use `documentation` instead of writing a Markdown file by hand?
 

docs/USAGE.md

@@ -10,15 +10,29 @@ $ npm install -g documentation
 `-h` to get help.
 
 ```sh
-$ documentation -h
-Usage: bin/documentation.js <command> [options]
+Usage: documentation <command> [options]
 
 Options:
-  -f, --format   output format, of [json, md]                  [default: "json"]
-  --mdtemplate   markdown template: should be a file with Handlebars syntax
-  -p, --private  generate documentation tagged as private
-  -h, --help     Show help
+  --lint             check output for common style and uniformity mistakes
+                                                                       [boolean]
+  -t, --theme        specify a theme: this must be a valid theme module
+  -p, --private      generate documentation tagged as private          [boolean]
+  --version          Show version number                               [boolean]
+  --name             project name. by default, inferred from package.json
+  --project-version  project version. by default, inferred from package.json
+  --shallow          shallow mode turns off dependency resolution, only
+                     processing the specified files (or the main script
+                     specified in package.json)       [boolean] [default: false]
+  --polyglot         polyglot mode turns off dependency resolution and enables
+                     multi-language support. use this to document c++  [boolean]
+  -g, --github       infer links to github in documentation            [boolean]
+  -o, --output       output location. omit for stdout, otherwise is a filename
+                     for single-file outputs and a directory name for multi-file
+                     outputs like html                       [default: "stdout"]
+  -c, --config       configuration file. an array defining explicit sort order
+  -h, --help         Show help                                         [boolean]
+  -f, --format                 [choices: "json", "md", "html"] [default: "json"]
 
 Examples:
-  documentation foo.js    parse documentation in a given file
+  documentation foo.js  parse documentation in a given file
 ```