# {{grunt-readme}} [![NPM version](https://badge.fury.io/js/helper-grunt-readme.png)](http://badge.fury.io/js/helper-grunt-readme)

> grunt-readme handlebars helper, for doing foo, bar and baz.


## Quickstart
In the root of your project, run the following in the command line:

```bash
npm i helper-grunt-readme --save-dev
```

## Usage

```handlebars
{{grunt-readme "path/to/file.grunt-readme"}}
```

## Usage in Assemble

In your Gruntfile, simply add `helper-grunt-readme` to the `helpers` property in the [Assemble](http://assemble.io) task or target options:

```javascript
grunt.initConfig({
  assemble: {
    options: {
      helpers: ['helper-grunt-readme']
    }
    ...
  }
});
```
With that completed, you may now being using the `grunt-readme` helper in your Assemble project.


## Options

### task options
Options can be set in your Gruntfile, in the `grunt-readme` object in the Assemble task or target options:

```javascript
grunt.initConfig({
  assemble: {
    options: {
      readme: {
        foo: true
      }
    }
    ...
  }
});
```

## Author

+ [github/Jon Schlinkert](https://github.com/jonschlinkert)
+ [twitter/Jon Schlinkert](http://twitter.com/Jon Schlinkert)


## License and Copyright

Licensed under the [MIT License](./LICENSE-MIT)
Copyright (c) Jon Schlinkert, contributors.

_This file was generated by [grunt-readme](https://github.com/assemble/grunt-readme) on Thursday, November 21, 2013._