Skip to content

Commit 5405e4e

Browse files
committed
Update the readme.md file
1 parent 62a3607 commit 5405e4e

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,20 @@
11
# github-release-notes
22
Node module to publish release notes based on commits between the last two tags.
3+
4+
## Installation
5+
6+
Install `github-release-notes` via npm:
7+
8+
```
9+
npm install github-release-notes --save-dev
10+
```
11+
12+
## Usage
13+
14+
- You can run the command via the terminal (the three arguments ar all required):
15+
16+
```
17+
node github-release-notes --token=[token] --username=[username] --repo=[repo name]
18+
```
19+
20+
To generate a github token, follow [this link](https://help.github.com/articles/creating-an-access-token-for-command-line-use/);

0 commit comments

Comments
 (0)