Skip to content

Commit cd6a5ca

Browse files
committed
Update the readme file
1 parent d62c6bd commit cd6a5ca

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,18 @@ npm install github-release-notes --save-dev
1111

1212
## Usage
1313

14-
- You can run the command via the terminal (the three arguments ar all required):
14+
You can run the command via the terminal (the three arguments ar all required):
1515

1616
```
1717
node github-release-notes --token=[token] --username=[username] --repo=[repo name]
1818
```
1919

20-
To generate a github token, follow [this link](https://help.github.com/articles/creating-an-access-token-for-command-line-use/);
20+
To generate a github token, follow [this link](https://help.github.com/articles/creating-an-access-token-for-command-line-use/);
21+
22+
### Optionals
23+
24+
There are optional arguments such as:
25+
26+
- `--draft=true' To set the release as a draft
27+
- `--prerelease=true' To set the release as a prerelease
28+
- `--prefix=` Add a prefix to the tag version `e.g. v1.0.1`

0 commit comments

Comments
 (0)