Merge pull request #15 from ldez/feat/documentation

doc: improve readme

README.md

@@ -1,14 +1,66 @@
 # usestdlibvars
 
-The Golang linter that detect possibility use variables/constants from stdlib
+A linter that detect the possibility to use variables/constants from the Go standard library.
 
 ## Install
 
-```console
+```
 go install github.com/sashamelentyev/usestdlibvars
 ```
 
 ## Usage
+
 ```console
+$ usestdlibvars -h                                                     
+usestdlibvars: Detect the possibility to use constants/variables from the stdlib.
+
+Usage: usestdlibvars [-flag] [package]
+
+
+Flags:
+  -V    print version and exit
+  -all
+        no effect (deprecated)
+  -c int
+        display offending line with this many lines of context (default -1)
+  -cpuprofile string
+        write CPU profile to this file
+  -crypto-hash
+        suggest the use of crypto.Hash
+  -debug string
+        debug flags, any subset of "fpstv"
+  -fix
+        apply all suggested fixes
+  -flags
+        print analyzer flags in JSON
+  -http-method
+        suggest the use of http.MethodXX (default true)
+  -http-status-code
+        suggest the use of http.StatusXX (default true)
+  -json
+        emit JSON output
+  -memprofile string
+        write memory profile to this file
+  -source
+        no effect (deprecated)
+  -tags string
+        no effect (deprecated)
+  -test
+        indicates whether test files should be analyzed, too (default true)
+  -time-layout
+        suggest the use of time.Layout
+  -time-month
+        suggest the use of time.Month
+  -time-weekday
+        suggest the use of time.Weekday
+  -trace string
+        write trace log to this file
+  -v    no effect (deprecated)
+
+```
+
+## Examples
+
+```bash
 usestdlibvars ./...
 ```

pkg/analyzer/analyzer.go

@@ -33,12 +33,12 @@ func New() *analysis.Analyzer {
 
 func flags() flag.FlagSet {
 	flags := flag.NewFlagSet("", flag.ExitOnError)
-	flags.Bool(HTTPMethodFlag, true, "")
-	flags.Bool(HTTPStatusCodeFlag, true, "")
-	flags.Bool(TimeWeekdayFlag, false, "")
-	flags.Bool(TimeMonthFlag, false, "")
-	flags.Bool(TimeLayoutFlag, false, "")
-	flags.Bool(CryptoHashFlag, false, "")
+	flags.Bool(HTTPMethodFlag, true, "suggest the use of http.MethodXX")
+	flags.Bool(HTTPStatusCodeFlag, true, "suggest the use of http.StatusXX")
+	flags.Bool(TimeWeekdayFlag, false, "suggest the use of time.Weekday")
+	flags.Bool(TimeMonthFlag, false, "suggest the use of time.Month")
+	flags.Bool(TimeLayoutFlag, false, "suggest the use of time.Layout")
+	flags.Bool(CryptoHashFlag, false, "suggest the use of crypto.Hash")
 	return *flags
 }