grunt-readme
Version:
Grunt plugin for generating a README from templates, including an optional table of contents. No Gruntfile config is necessary, just choose a starter template and you'll be ready to go.
16 lines (14 loc) • 351 B
Markdown
### Overview
In your project's Gruntfile, add a section named `{%= _.shortname(name) %}` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
{%= _.shortname(name) %}: {
options: {
// Task-specific options go here.
},
target: {
// Target-specific file lists and/or options go here.
}
}
})
```