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.

34 lines (23 loc) 911 B
--- username: jonschlinkert --- # {{{%= shortname %}}} [![NPM version](https://badge.fury.io/js/{%= name %}.png)](http://badge.fury.io/js/{%= name %}) {% if (travis) { %} [![Build Status]({%= travis %}.png)]({%= travis %}){% } %} > {%= description %} ## Quickstart {%= _.doc("quickstart.md") %} ## Options {%= _.doc("options.md") %} ## Usage Examples {%= _.doc("examples.md") %} ## Contributing Please see the [Contributing to Assemble](http://assemble.io/contributing) guide for information on contributing to this project. ## Related Projects and Links {%= _.doc("repos.md") %} ## 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") %}._