UNPKG

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.

14 lines (13 loc) 321 B
In your project's Gruntfile, add a section named `{%= shortname %}` to the data object passed into `grunt.initConfig()`. ```js grunt.initConfig({ {%= shortname %}: { options: { // Task-specific options go here. }, target: { // Target-specific file lists and/or options go here. } } }) ```