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.

60 lines (43 loc) 1.76 kB
--- username: jonschlinkert --- # {%= name %} [![NPM version](https://badge.fury.io/js/{%= name %}.png)](http://badge.fury.io/js/{%= name %}) {% if (travis) { %} [![Build Status]({%= travis %}.png)]({%= travis %}){% } %} > {%= description %} [Also see examples →](./EXAMPLES.md) and [documentation →](./DOCS.md) Please [report any bugs or feature requests](https://github.com/helpers/{%= name %}/issues/new), thanks! ## Quickstart {%= _.doc("docs-quickstart.md") %} ## Example README template {%= _.doc("docs-example.md") %} ## Contributing Please see the [Contributing to {%= name %}]({%= homepage %}/blob/master/CONTRIBUTING.md) guide for information on contributing to this project. ## Release History {% if (changelog) { _.each(changelog, function(details, version) { var date = details.date; if (date instanceof Date) { date = grunt.template.date(new Date(date.getTime() + date.getTimezoneOffset() * 60000), 'yyyy-mm-dd'); } print('\n * ' + [ date, version, details.changes.join(' '), ].join('\u2003\u2003\u2003')); }); } else { %} _(Nothing yet)_ {% } %} ## Test Mixins * `[%= name %]`: {%= name %} * `[%= shortname %]`: {%= shortname %} ## Author + [github.com/{%= username %}](https://github.com/{%= username %}) + [twitter.com/{%= username %}](http://twitter.com/{%= username %}) ## License {%= copyright %} {%= license %} *** _This file was generated by [grunt-readme](https://github.com/assemble/grunt-readme) on {%= grunt.template.date("fullDate") %}._ [grunt]: http://gruntjs.com/ [Getting Started]: https://github.com/gruntjs/grunt/blob/devel/docs/getting_started.md [package.json]: https://npmjs.org/doc/json.html