Better help text for the generate subcommand.

Addresses issue npryce#36
andersab · Jun 25, 2018 · fda2732 · fda2732
1 parent b376d9a
commit fda2732
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/src/adr-generate b/src/adr-generate
@@ -5,6 +5,23 @@ eval "$($(dirname $0)/adr-config)"
 ## usage: adr generate [REPORT [OPTION ...]]
 ##
 ## Generates summary documentation about the architecture decision records.
+##
+## To list the report types that can be generated, run:
+##
+##     adr generate
+##
+## To get help on a specific report generator, run:
+##
+##     adr help generate <report-type>
+##
+## For example, the following command will run the "toc" (table of contents) 
+## generator:
+##
+##     adr generate toc
+##
+## The following command will display help for the "toc" generator:
+##
+##     adr help generate toc
 
 cmd=$1