Skip to content

Commit

Permalink
docs(README): Reorder contents
Browse files Browse the repository at this point in the history
  • Loading branch information
rafinskipg committed Jun 10, 2015
1 parent a99b7af commit 14e8a77
Showing 1 changed file with 17 additions and 16 deletions.
33 changes: 17 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,22 +47,6 @@ Since version `0.2.0` git-changelog has included the [`.changelogrc` specificati
- `tag = false` && `group=false` will log from the begining of the project, without grouping by tag


## Getting Started
This plugin requires Grunt `~0.4.1`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install git-changelog --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('git-changelog');
```


## `.changelogrc` specification

The `.changelogrc` file contains the commit specification that you and your team are following.
Expand Down Expand Up @@ -93,6 +77,23 @@ _The format of each line im the sections is `grep : SectionTitle`_
## The "git_changelog" task

### Grunt Task

#### Getting Started
This plugin requires Grunt `~0.4.1`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install git-changelog --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('git-changelog');
```


In your project's Gruntfile, add a section named `git_changelog` to the data object passed into `grunt.initConfig()`.

```js
Expand Down

0 comments on commit 14e8a77

Please sign in to comment.