docs: update help text

csdev · Apr 13, 2023 · 966c8ce · 966c8ce
1 parent c5412ab
commit 966c8ce
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -101,12 +101,14 @@ _coming soon_
 
 ```
 Usage: conch [options] <revision_range>
+       conch [-k|--hook] <filename>
   -h, --help                             display this help text
   -q, --quiet                            suppress error messages for bad commits
   -v, --verbose                          verbose log output
   -V, --version                          display version and build info
   -c, --config string                    path to config file
   -r, --repo string                      path to the git repository
+  -k, --hook                             run as git commit-msg hook, validating a file (see docs)
   -T, --types comma_separated_strings    filter commits by type
   -S, --scopes comma_separated_strings   filter commits by scope
   -B, --breaking                         show breaking changes (e.g., feat!)

diff --git a/cmd/conch/main.go b/cmd/conch/main.go
@@ -116,9 +116,8 @@ func main() {
 		filters.Types = nil
 		filters.Scopes = nil
 
-		const usage = "Usage: \n" +
-			"    %s [options] <revision_range>\n" +
-			"    %s [-k|--hook] <filename>\n"
+		const usage = "Usage: %s [options] <revision_range>\n" +
+			"       %s [-k|--hook] <filename>\n"
 
 		fmt.Fprintf(os.Stderr, usage, os.Args[0], os.Args[0])
 		flag.PrintDefaults()