Updated docs

docs/Makefile

@@ -22,6 +22,7 @@ toc:
 		$(UPDATE_TOC) class_diagrams.md
 		$(UPDATE_TOC) comment_decorators.md
 		$(UPDATE_TOC) common_options.md
+		$(UPDATE_TOC) generator_types.md
 		$(UPDATE_TOC) configuration_file.md
 		$(UPDATE_TOC) diagram_filters.md
 		$(UPDATE_TOC) doxygen_integration.md

docs/README.md

@@ -3,7 +3,8 @@
 * [Quick start](./quick_start.md)
 * [Installation](./installation.md)
 * Generating diagrams
-  * [Common options](./common_options.md) 
+  * [Common options](./common_options.md)
+  * [Generator types](./generator_types.md)
   * [Class diagrams](./class_diagrams.md)
   * [Sequence diagrams](./sequence_diagrams.md)
   * [Package diagrams](./package_diagrams.md)

docs/generator_types.md

@@ -0,0 +1,22 @@
+# Generator types
+
+<!-- toc -->
+
+* [PlantUML](#plantuml)
+* [JSON](#json)
+
+<!-- tocstop -->
+
+Currently, there are 2 types of diagram generators: `plantuml` and `json`.
+
+## PlantUML
+
+Generates UML diagrams in textual PlantUML format, which can then
+be converted to various image formats.
+
+## JSON
+
+Generates a JSON representation of the intermediate `clang-uml` model, which
+can be used for scripting, integrations as well as analysing the code base
+or even generating diagrams in other formats.
+

docs/quick_start.md

@@ -56,7 +56,7 @@ To add an initial class diagram to your project, follow these steps:
      - another_diagram [sequence]
      - some_class_diagram [class]
    ```
-7. Generate only the new diagram:
+7. Generate only the new diagram in JSON format:
    ```bash
-   clang-uml -n another_diagram
+   clang-uml -n another_diagram -g json
    ```