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 (23 loc) 862 B
# {%= name %} {%= _.badge("fury") %} {%= _.badge("travis") %} > {%= description %} ## Getting Started {%= _.doc("docs-getting-started.md") %} ## Options {%= _.doc("docs-options.md") %} ## Usage Examples {%= _.doc("docs-examples.md") %} ## Contributing In lieu of a forma l 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][]. {% if (author.name) { %} ## Author + [github/{%= author.name %}]({%= author.name %}) + [twitter/{%= author.name %}](http://twitter.com/{%= author.name %}){% } %} {% if (changelog) { %} ## Release History {%= _.include("docs-changelog.md") %} {% } %} ## License {%= copyright %} {%= license %} *** _This file was generated by [grunt-readme](https://github.com/assemble/grunt-readme) on {%= grunt.template.date("fullDate") %}._