Skip to content

Commit

Permalink
Merge branch 'master' of github.com:alexcanessa/github-release-notes
Browse files Browse the repository at this point in the history
  • Loading branch information
alexcanessa committed Nov 18, 2015
2 parents 041a153 + 75c4408 commit 4420abc
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,23 @@

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

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.
> 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.
## Installation

The plugin requires Node `^0.12.`, since is using Promises.

Install `github-release-notes` via npm:

```
```shell
npm install github-release-notes --save-dev
```

## Usage

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

```
```shell
node github-release-notes --token=[token] --username=[username] --repo=[repo name]
```

Expand Down

0 comments on commit 4420abc

Please sign in to comment.