From 75c440888a44a453feefa6c7bbd208efb9b26de0 Mon Sep 17 00:00:00 2001 From: Alex Canessa Date: Wed, 18 Nov 2015 11:35:35 +0200 Subject: [PATCH] Update README.md --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b45c84a7..819c60a6 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,15 @@ [![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 ``` @@ -16,7 +18,7 @@ npm install github-release-notes --save-dev 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] ```