From d31b8477e75a51de2fb3fe59ea1b73c89a1444c5 Mon Sep 17 00:00:00 2001
From: eelcofolkertsma <71253997+eelcofolkertsma@users.noreply.github.com>
Date: Wed, 3 Apr 2024 11:58:52 +0200
Subject: [PATCH] docs: update usage doc with info about `--watch` flag and
 absence of `--version` flag (#1142)

Co-authored-by: Florence Njeri <40742916+Florence-Njeri@users.noreply.github.com>%0ACo-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
---
 docs/usage.md | 37 +++++++++++++++++++++----------------
 1 file changed, 21 insertions(+), 16 deletions(-)

diff --git a/docs/usage.md b/docs/usage.md
index 87bdb1717..344044680 100644
--- a/docs/usage.md
+++ b/docs/usage.md
@@ -8,24 +8,29 @@ There are two ways to use the generator:
 - [Generator library](#using-as-a-modulepackage)
 
 ## AsyncAPI CLI
+Generates whatever you want using templates compatible with AsyncAPI Generator.
 ```bash
-Usage: asyncapi generate fromTemplate <asyncapi> <template> [<options>]
+USAGE
+  $ asyncapi generate fromTemplate [ASYNCAPI] [TEMPLATE] [-h] [-d <value>] [-i] [--debug] [-n <value>] [-o <value>] [--force-write] [-w] [-p <value>] [--map-base-url <value>]
 
-- <asyncapi>: Local path or URL pointing to AsyncAPI document for example https://bit.ly/asyncapi
-- <template>: Name of the generator template like for example @asyncapi/html-template or https://github.com/asyncapi/html-template
+ARGUMENTS
+  ASYNCAPI  - Local path, url or context-name pointing to AsyncAPI file
+  TEMPLATE  - Name of the generator template like for example @asyncapi/html-template or https://github.com/asyncapi/html-template
 
-- <options>:
-  -V, --version                  output the generator version
-  -d, --disable-hook [hooks...]  disable a specific hook type or hooks from a given hook type
-  --debug                        enable more specific errors in the console
-  -i, --install                  install the template and its dependencies (defaults to false)
-  -n, --no-overwrite <glob>      glob or path of the file(s) to skip when regenerating
-  -o, --output <outputDir>       directory to put the generated files (defaults to current directory)
-  -p, --param <name=value>       additional parameters to pass to templates
-  --force-write                  force writing of the generated files to a given directory even if it is a Git repository with unstaged files or not empty dir (defaults to false)
-  --watch-template               watches the template directory and the AsyncAPI document, and re-generates the files when changes occur. Ignores the output directory. This flag should be used only for template development.
-  --map-base-url <url:folder>    maps all schema references from base URL to local folder
-  -h, --help                     display help for command
+FLAGS
+  -d, --disable-hook=<value>...  Disable a specific hook type or hooks from a given hook type
+  -h, --help                     Show CLI help.
+  -i, --install                  Installs the template and its dependencies (defaults to false)
+  -n, --no-overwrite=<value>...  Glob or path of the file(s) to skip when regenerating
+  -o, --output=<value>           Directory where to put the generated files (defaults to current directory)
+  -p, --param=<value>...         Additional param to pass to templates
+  -w, --watch                    Watches the template directory and the AsyncAPI document, and re-generate the files when changes occur. Ignores the output directory.
+  --debug                        Enable more specific errors in the console
+  --force-write                  Force writing of the generated files to given directory even if it is a git repo with unstaged files or not empty dir (defaults to false)
+  --map-base-url=<value>         Maps all schema references from base url to local folder
+
+EXAMPLES
+  $ asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --param version=1.0.0 singleFile=true --output ./docs --force-write
 ```
 
 All templates are installable npm packages. Therefore, the value of `template` can be anything supported by `npm install`. Here's a summary of the possibilities:
@@ -149,4 +154,4 @@ try {
 }
 ```
 
-See the [API documentation](api) for more examples and full API reference information.
+See the [API documentation](api) for more examples and full API reference information.
\ No newline at end of file