When you first add grunt-readme to a project, the task will automatically add a readme if it doesn't find one. But it's recommended that you customize you're own README template. Feel free to use any of the templates included in this repo, or copy/past the blow example into ./docs/README.tmpl.md:

# {%= name %}

>{%= description %}

{%= toc %}

## Overview

{%= _.doc("overview.md")%}

## Options

{%= _.doc("options.md")%}

## Examples

{%= _.doc("examples.md")%}

## License and Copyright

{%= copyright %}

{%= license %}

Then add overview.md, options.md and examples.md to the ./docs directory. Of course, all of this is completely optional.

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt, and build the documentation with grunt-readme.

Pull requests are also encouraged, and if you find this project useful please consider "starring" it to show your support! Thanks!