From 387638ee59993e9652aa64a255f10ee4a1023a7d Mon Sep 17 00:00:00 2001 From: "[riftbit] ErgoZ" Date: Fri, 10 Jun 2022 18:25:34 +0000 Subject: [PATCH] chore(readme): update usage example in readme --- README.md | 13 ++++++++++++- cmd/namegen/main.go | 2 +- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1ff26ce..f68a55c 100644 --- a/README.md +++ b/README.md @@ -31,10 +31,21 @@ func main() { } ``` -## Install binary +## Use binary command You can install binary with `namegen` name to get names in command line +Example: + +``` +namegen -retries=1 +``` + +or just call `namegen` binary to get new name. + +if `retries` flag is non-zero, a random integer between 0 and 10 will be added to the end of the name, e.g 'focused_turing3' + + ### if golang installed ``` diff --git a/cmd/namegen/main.go b/cmd/namegen/main.go index 51f5057..986f3d9 100644 --- a/cmd/namegen/main.go +++ b/cmd/namegen/main.go @@ -12,7 +12,7 @@ import ( func main() { var retriesCount int - flag.IntVar(&retriesCount, "retries", 0, "If retry is non-zero, a random integer between 0 and 10 will be added to the end of the name, e.g 'focused_turing3'") + flag.IntVar(&retriesCount, "retries", 0, "if is non-zero, a random integer between 0 and 10 will be added to the end of the name, e.g 'focused_turing3'") flag.Parse() rand.Seed(time.Now().UnixNano())