Skip to content

Commit 4c6f988

Browse files
committed
Improves help text
1 parent a7f92b5 commit 4c6f988

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

main.go

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,21 @@ func init() {
5858

5959
var usage string = `Github command line release tool.
6060
Usage:
61-
gh-release <user/repo> <tag> <branch> <description> <files>
62-
63-
<files> can be specified using glob patterns.
64-
61+
github-release <user/repo> <tag> <branch> <description> <files>
62+
63+
Parameters:
64+
<user/repo>: Github user and repository
65+
<tag>: Used to created the release. It is also used as the release's name
66+
<branch>: Reference from where to create the provided <tag>, if it does not exist
67+
<description>: The release description
68+
<files>: Glob pattern describing the list of files to include in the release
6569
Options:
6670
-version: Displays version
71+
72+
Before using this tool make sure you set the environment variable GITHUB_TOKEN
73+
with a valid Github token and correct authorization scopes to allow you to create releases
74+
in your project.
75+
6776
`
6877

6978
func main() {

0 commit comments

Comments
 (0)