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.

28 lines (19 loc) 875 B
# {%= name %} [![NPM version](https://badge.fury.io/js/{%= name %}.png)](http://badge.fury.io/js/{%= name %}) {% if (travis) { %} [![Build Status]({%= travis %}.png)]({%= travis %}){% } %} > {%= description %} ## Getting Started {%= _.doc("quickstart.md") %} ## Options {%= _.doc("options.md") %} ## Usage Examples {%= _.doc("examples.md") %} ## Contributing 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][]. {% if (author.url) { %} ## Author + [github/{%= author.url %}]({%= author.url %}) + [twitter/{%= author.url %}](http://twitter.com/{%= author.url %}){% } %} ## License {%= copyright %} {%= license %} *** _This file was generated by [grunt-readme](https://github.com/assemble/grunt-readme) on {%= grunt.template.date("fullDate") %}._