diff --git a/README.md b/README.md index 07137a8..f86c7e3 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,14 @@ -### The "Version" package +### The "Help" package -This package provides --version flag feature to your cli. -It recognize both short and long flags. Version number is -automatically added from the latest tag in your git repository. +This package provides --help flag feature to your cli. +It recognize both short and long flags. ------------- ### Usage 1. Download the package by **go get** command: ```shell -go get code.foilhatguy.casa/pub/version +go get code.foilhatguy.casa/pub/help ``` 2. Add the package as a tool dependency to your project in tools.go: @@ -19,23 +18,21 @@ tools.go: package tools import ( - _ "code.foilhatguy.casa/pub/version" + _ "code.foilhatguy.casa/pub/help" ) ``` 3. In the main package add a go:generate directive: ```go -//go:generate go run code.foilhatguy.casa/pub/version +//go:generate go run code.foilhatguy.casa/pub/help ``` 4. Run code generator by **go generate** command: ```shell go generate ./... ``` -The package will detect a version number from the latest git -tag from your project. Then it will generate a **version.go** -file as a part of the main package. It will contain a version -number as a constant and code for --version flag detection. +The package will generate a **help.go** file as a part of +the main package. It will contain code for --help flag detection. -5. Build and run your application with the --version flag. +5. Build and run your application with the --help flag. ```shell -go run . --version +go run . --help ``` \ No newline at end of file