extra help

Author: tebeka

README.md

@@ -6,6 +6,21 @@ Prints GitHub project description for every direct dependency on GitHub in go.mo
 
 ## Usage
 
+```
+usage: expmod [options] [file or URL]
+Options:
+  -timeout duration
+    	HTTP timeout (default 3s)
+  -version
+    	show version and exit
+
+If GITHUB_TOKEN is found in the environment, it will be use to access GitHub API.
+"Human" GitHub URLs (e.g. https://github.com/tebeka/expmod/blob/main/go.mod) will be redirected to raw content.
+```
+
+
+## Example
+
 ```
 $ expmod go.mod 
 github.com/sahilm/fuzzy v0.1.0:

main.go

@@ -30,15 +30,19 @@ const (
 	tokenKey = "GITHUB_TOKEN" // #nosec G101
 )
 
+var extraHelp = `
+If %s is found in the environment, it will be use to access GitHub API.
+"Human" GitHub URLs (e.g. https://github.com/tebeka/expmod/blob/main/go.mod) will be redirected to raw content.
+`
+
 func main() {
 	exe := path.Base(os.Args[0])
 	flag.BoolVar(&showVersion, "version", false, "show version and exit")
 	flag.DurationVar(&httpTimeout, "timeout", 3*time.Second, "HTTP timeout")
 	flag.Usage = func() {
 		fmt.Fprintf(os.Stderr, "usage: %s [options] [file or URL]\nOptions:\n", exe)
 		flag.PrintDefaults()
-		fmt.Fprintln(os.Stderr)
-		fmt.Fprintf(os.Stderr, "If %s is found in the environment, it will be use to access GitHub API.\n", tokenKey)
+		fmt.Fprintf(os.Stderr, extraHelp, tokenKey)
 	}
 	flag.Parse()