Skip to content

Commit 75c4408

Browse files
committed
Update README.md
1 parent 7ddbef1 commit 75c4408

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,23 @@
22

33
[![npm version](https://badge.fury.io/js/github-release-notes.svg)](https://badge.fury.io/js/github-release-notes)
44

5-
Node module which generates a release from the latest tag and compiles release notes based on commit messages between the last tag and the latest release.
5+
> Node module which generates a release from the latest tag and compiles release notes based on commit messages between the last tag and the latest release.
66
77
## Installation
88

9+
The plugin requires Node `^0.12.`, since is using Promises.
10+
911
Install `github-release-notes` via npm:
1012

11-
```
13+
```shell
1214
npm install github-release-notes --save-dev
1315
```
1416

1517
## Usage
1618

1719
You can run the command via the terminal (the three arguments are all required):
1820

19-
```
21+
```shell
2022
node github-release-notes --token=[token] --username=[username] --repo=[repo name]
2123
```
2224

0 commit comments

Comments
 (0)