From c0c1522dd71a740498609fc63d358995584b4122 Mon Sep 17 00:00:00 2001
From: Yukun Wang <airycanon@airycanon.me>
Date: Thu, 4 Apr 2024 04:02:19 +0800
Subject: [PATCH] Add output mode in README.md (#77)

This updates the README.md to document the new output-mode flag.

---------
Co-authored-by: Thibault Richard <thbkrkr@users.noreply.github.com>
---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/README.md b/README.md
index bc18ceb..6100e44 100644
--- 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.