chore: add description to usage

jar-b · Sep 15, 2023 · deb8338 · deb8338
1 parent a4da457
commit deb8338
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -29,6 +29,8 @@ go install github.com/jar-b/mdtoc/cmd/mdtoc@latest
 
 ```
 $ mdtoc -h
+Generate a table of contents for an existing markdown document.
+
 Usage: mdtoc [flags] [filename]
 
 Flags:

diff --git a/cmd/mdtoc/main.go b/cmd/mdtoc/main.go
@@ -16,15 +16,13 @@ var (
 	tocHeading string = mdtoc.DefaultTocHeading
 )
 
-func init() {
+func main() {
 	// slightly better usage output
 	flag.Usage = func() {
+		fmt.Fprint(flag.CommandLine.Output(), "Generate a table of contents for an existing markdown document.\n\n")
 		fmt.Fprintf(flag.CommandLine.Output(), "Usage: %s [flags] [filename]\n\nFlags:\n", os.Args[0])
 		flag.PrintDefaults()
 	}
-}
-
-func main() {
 	flag.BoolVar(&force, "force", false, "force overwrite of existing contents (optional)")
 	flag.BoolVar(&dryRun, "dry-run", false, "print generated contents, but do not write to file (optional)")
 	flag.StringVar(&out, "out", "", "output file (optional, defaults to adding to source file)")