Integrate 0.5.0 (#4)

* Update the module to the latest gren

* Update the CHANGELOG.md

* Update README.md

Author: alexcanessa

.editorconfig

@@ -0,0 +1,14 @@
+# Editor code style configuration
+# http://editorconfig.org/
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.jshintrc

@@ -0,0 +1,17 @@
+# Changelog
+
+## 0.3.0 (03/03/2016)
+
+*No changelog for this release.*
+
+ --- 
+
+## 0.2.1 (19/11/2015)
+
+*No changelog for this release.*
+
+ --- 
+
+## 0.2.0 (19/11/2015)
+
+*No changelog for this release.*

CHANGELOG.md

@@ -2,12 +2,11 @@
 
 [![npm version](https://badge.fury.io/js/grunt-github-release-notes.svg)](https://badge.fury.io/js/grunt-github-release-notes)
 
-> Grunt module to publish release notes based on commits between the last two tags.
+> Grunt module to publish release notes based on commits between two tags.
 This module is using [github-release-notes](https://github.com/alexcanessa/github-release-notes).
 
-
 ## Getting Started
-This plugin requires Grunt `~0.4.5`
+This plugin requires Grunt `~0.4.5` and github-release-notes `^0.5.0`
 
 ```shell
 npm install grunt-github-release-notes --save-dev
@@ -21,29 +20,70 @@ grunt.loadNpmTasks('grunt-github-release-notes');
 
 ## The "release" task
 
-### Overview
-In your project's Gruntfile, add a section named `gren` to the data object passed into `grunt.initConfig()`.
-**`token`, `username` and `repo` are required.**
+Before you can use it, you need to set up a couple of things.
+
+### Github Informations
+
+**gren** by default looks for your local git configuration to get the repo informations. This means you can run the command directly from the git repo folder.
+
+Otherwise, you can run it from wherever and specify a different repo as target, with:
 
 ```js
-gren: {
-	release: {
-		options: {
-			token: 'GITHUB_TOKEN',
-			username: 'GITHUB_USERNAME',
-			repo: 'GITHUB_REPO_NAME'
-		}
-	}
+options: {
+    username: USERNAME,
+    repo: REPO_NAME
+}
+```
+
+#### Token
+
+To work, **gren** needs a `github token` (that can be easily generated following [this link](https://help.github.com/articles/creating-an-access-token-for-command-line-use/)). _You only need "repo" scope._
+
+Once generated, you can run the gren command with the token as variable:
+
+```js
+options: {
+    token: YOUR_TOKEN_HERE
 }
 ```
 
-To generate a github token, follow [this link](https://help.github.com/articles/creating-an-access-token-for-command-line-use/);
+Or you can add it to your `~/.bash_profile` or `~/.zshrc`) as follows:
 
-### Optionals
-There are optional arguments such as:
+```shell
+export GREN_GITHUB_TOKEN=your_token_here
+```
+
+## Options
+
+The options are the same as [github-release-notes](https://github.com/alexcanessa/github-release-notes), in camelCase:
+
+- `tags: 0.1.0|0.2.0,0.1.0` A specific tag or the range of tags to build the release notes from.
+- `timeWrap: latest|history` The release notes you want to include in the changelog. Default: `latest` _Only applicable to the `changelog` action_
+- `changelogFilename: CHANGELOG.md` The name of the changelog file. Default: `CHANGELOG.md`
+- `dataSource: issues|commits` The informations you want to use to build release notes. Default: `issues`
+- `draft: true|false` To set the release as a draft. Default: `false`
+- `prerelease: true|false` To set the release as a prerelease. Default: `false`
+- `prefix: v` Add a prefix to the tag version `e.g. v1.0.1`. Default: `null`
+- `includeMessages: merges|commits|all` used to filter the messages added to the release notes. Default: `commits`
+- `override: true|false` Override the release notes if existing. Default: `false`
+
+### Example
 
-- `draft: true` To set the release as a draft. Default: `false`
-- `prerelease: true` To set the release as a prerelease. Default: `false`
-- `prefix: 'v'` Add a prefix to the tag version `e.g. v1.0.1`.
-- `force: true` Doesn't fail the task if the task presents any errors. Default: `false`
-- `includeMessages: merges/commits/all` used to filter the messages added to the release notes. Default: `commits`
+The module accepts two targets: *release* and *changelog*.
+
+The *release* task will generate the last release, while the *changelog* will add the release notes to the changelog (without committing the file);
+
+```js
+gren: {
+    release: {
+        options: {
+            prefix: 'v'
+        }
+    },
+    changelog: {
+        options: {
+            changelogFilename: 'CHANGELOG.md'
+        }
+    }
+}
+```

README.md

@@ -1,7 +1,7 @@
 {
   "name": "grunt-github-release-notes",
   "description": "Grunt plugin for the npm github-release-notes",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "homepage": "https://github.com/alexcanessa/grunt-github-release-notes",
   "author": {
     "name": "Alex Canessa",
@@ -36,6 +36,6 @@
     "gruntplugin"
   ],
   "dependencies": {
-    "github-release-notes": "^0.4.0"
+    "github-release-notes": "^0.5.0"
   }
 }

package.json

@@ -8,7 +8,7 @@
 
 'use strict';
 
-var Gren = require('github-release-notes/src/index.js');
+var GithubReleaseNotes = require('github-release-notes/src/gren.js');
 
 module.exports = function(grunt) {
 
@@ -18,11 +18,20 @@ module.exports = function(grunt) {
   grunt.registerMultiTask('gren', 'Grunt plugin for the npm github-release-notes', function() {
     var options = this.options({});
     var done = this.async();
+    var gren = new GithubReleaseNotes(options);
 
-    var gren = new Gren(options);
+    if (this.target !== 'release' && this.target !== 'changelog') {
+        throw new Error('The target needs to be either release or changelog');
+    }
 
-	gren.release().then(done);
+    var component = this;
 
+	gren.init()
+		.then(function (success) {
+			if(success) {
+			    return gren[component.target]();
+			}
+		}).then(done);
   });
 
-};
+};