Add output mode in README.md (elastic#77)

This updates the README.md to document the new output-mode flag. --------- Co-authored-by: Thibault Richard <[email protected]>
airycanon · Apr 3, 2024 · c0c1522 · c0c1522
1 parent f496aea
commit c0c1522
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -47,6 +47,17 @@ crd-ref-docs \
     --templates-dir=templates/asciidoctor
 ```
 
+Default output mode writes all data to a single output file. 
+You can choose between single mode and group mode by specifying the output mode. 
+In group mode, separate files are created for each API group, ensuring that the specified output path is an existing directory.
+```
+crd-ref-docs \
+    --source-path=$GOPATH/src/github.com/elastic/cloud-on-k8s/pkg/apis \
+    --config=config.yaml \
+    --output-path=./docs \
+    --output-mode=group
+```
+
 ### Configuration
 
 Configuration options such as types and fields to exclude from the documentation can be specified using a YAML file.