Add detailed example code and improve warnings

Fix #1

Author: auscaster

README.md

@@ -1,8 +1,8 @@
 # Moxygen
 
-Moxygen is a doxygen XML to markdown converter for developers who want a beautiful and minimal documentation solution for their C++ projects.
+Moxygen is a Doxygen XML to Markdown converter for C++ developers who want a minimal beautiful and  documentation solution for their projects.
 
-The code is based on `doxygen2md` with extra options for generating output files, custom templates, and generating multipage documentation.
+The code is based on `doxygen2md` with extra options for generating output files, custom templates, and generating multi page documentation.
 
 Moxygen is currently used in conjunction with GitBook to generate the API documentation for LibSourcey, which can be viewed [here](http://sourcey.com/libsourcey/).
 
@@ -21,20 +21,35 @@ Moxygen is currently used in conjunction with GitBook to generate the API docume
     -V, --version          output the version number
     -v, --verbose          verbose mode
     -a, --anchors          add anchors to internal links
-    -g, --modules          output doxygen modules into separate files
+    -g, --groups           output doxygen modules into separate files
     -l, --language <lang>  programming language
     -t, --templates <dir>  custom templates directory
     -o, --output <file>    output file (must contain %s when using modules)
   ```
 
-## Multipage Output
+## Multi Page Output
 
-Moxygen supports the doxygen [modules](http://www.stack.nl/~dimitri/doxygen/manual/grouping.html#modules) syntax for generating multipage documentation.
-
-Every [\defgroup](http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmddefgroup) in your source code will be parsed and output into a separate markdown file, with internal reference updated accordingly.
+Moxygen supports the doxygen [modules](http://www.stack.nl/~dimitri/doxygen/manual/grouping.html#modules) syntax for generating multi page documentation. iEvery [\defgroup](http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmddefgroup) in your source code will be parsed and output into a separate markdown file, with internal reference updated accordingly.
 
 Example:
 
 ```
-moxygen --anchors --modules --output api-%s.md /path/to/doxygen/xml
+moxygen --verbose --anchors --modules --output api-%s.md /path/to/doxygen/xml
+```
+
+## Example
+
+To get a feel for how Moxygen works you can play with the example which is located in the `example` folder. The example contains:
+
+* Documented C++ example code
+* A `Doxyfile` file (for doxygen 1.8.13)
+* Pre-generated XML output in `example/xml`
+* Pre-generated output Markdown files in `example/doc`.
+
+The rebuild the example XML you can run `doxygen` from within the example folder.
+
+Now you can build the example documentation with the following command from within the example folder:
+
+```
+moxygen --verbose --groups --output=doc/api-%s.md xml
 ```

bin/moxygen.js

@@ -11,7 +11,7 @@ program.version(pjson.version)
   .usage('[options] <doxygen directory>')
   .option('-v, --verbose', 'verbose mode', false)
   .option('-a, --anchors', 'add anchors to internal links', false)
-  .option('-g, --modules', 'output doxygen modules into separate files', false)
+  .option('-g, --groups', 'output doxygen modules into separate files', false)
   .option('-l, --language <lang>', 'programming language', String, 'cpp')
   .option('-t, --templates <dir>', 'custom templates directory', String, 'templates')
   .option('-o, --output <file>', 'output file (must contain %s when using modules)', String, 'api.md')
@@ -25,7 +25,7 @@ if (program.args.length) {
   app.run(assign({}, app.defaultOptions, {
     directory: program.args[0],
     anchors: program.anchors,
-    modules: program.modules,
+    groups: program.groups,
     language: program.language,
     templates: program.templates,
     output: program.output