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.

32 lines (17 loc) 1.13 kB
# grunt-readme [![NPM version](https://badge.fury.io/js/grunt-readme.png)](http://badge.fury.io/js/grunt-readme) > 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. ## Getting Started ## Options ## Contributing Please see the [Contributing to Assemble](http://assemble.io/contributing) guide for information on contributing to this project. ## Author **Jon Schlinkert** + [github.com/](https://github.com/) + [twitter.com/](http://twitter.com/) ## Related + [helpers](https://github.com/helpers): some great handlebars helpers that we decided not to include in the [handlebars-helpers](https://github.com/assemble/handlebars-helpers) project, most likely because the code footprint was too big or the helper wasn't generic enough. ## License Copyright (c) 2013 Jon Schlinkert, contributors. Released under the MIT license *** _This file was generated by [grunt-readme](https://github.com/assemble/grunt-readme) on Thursday, November 21, 2013._