Skip to content

Commit d1e4182

Browse files
committed
Improves help text
1 parent c6a6a99 commit d1e4182

File tree

2 files changed

+15
-8
lines changed

2 files changed

+15
-8
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,22 @@ Yet another Github release command line tool. This one, though, is much more min
55
```
66
Github command line release tool.
77
Usage:
8-
gh-release <user/repo> <tag> <branch> <description> <files>
9-
10-
<files> can be specified using glob patterns.
8+
github-release <user/repo> <tag> <branch> <description> <files>
119
10+
Parameters:
11+
<user/repo>: Github user and repository
12+
<tag>: Used to created the release. It is also used as the release's name
13+
<branch>: Reference from where to create the provided <tag>, if it does not exist
14+
<description>: The release description
15+
<files>: Glob pattern describing the list of files to include in the release
1216
Options:
13-
-version: Displays version
14-
```
17+
-version: Displays version
1518
16-
### Requirements
17-
Make sure you have a Github token with the correct authorization scope to allow you to create releases. For more information about creating tokens please read https://help.github.com/articles/creating-an-access-token-for-command-line-use/
19+
Before using this tool make sure you set the environment variable GITHUB_TOKEN
20+
with a valid Github token and correct authorization scopes to allow you to create releases
21+
in your project. For more information about creating Github tokens please read the
22+
official Github documentation at https://help.github.com/articles/creating-an-access-token-for-command-line-use/
23+
```
1824

1925
### Examples
2026
Feel free to inspect this project's [Makefile](https://github.com/c4milo/github-release/blob/master/Makefile) for an example on how this tool can be used to create releases like this:

main.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,8 @@ Options:
7171
7272
Before using this tool make sure you set the environment variable GITHUB_TOKEN
7373
with a valid Github token and correct authorization scopes to allow you to create releases
74-
in your project.
74+
in your project. For more information about creating Github tokens please read the
75+
official Github documentation at https://help.github.com/articles/creating-an-access-token-for-command-line-use/
7576
7677
`
7778

0 commit comments

Comments
 (0)