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.

84 lines (59 loc) 2.23 kB
# Badges ## codeclimate ```js [%= _.codeclimate() %] // => [![Code Climate](https://codeclimate.com/github/ruby/ruby.png)](https://codeclimate.com/github/ruby/ruby) ``` ## coderwall ```js [%= _.coderwall() %] // => [![endorse](https://api.coderwall.com/jonschlinkert/endorsecount.png)](https://coderwall.com/jonschlinkert) ``` ## coveralls ```js [%= _.coveralls() %] // => [![Coverage Status](https://coveralls.io/repos/assemble/assemble/badge.png?branch=master)](https://coveralls.io/r/assemble/assemble?branch=master) ``` ## [david](https://david-dm.org/) [![dependencies](https://david-dm.org/assemble/assemble.png)](https://david-dm.org/assemble/assemble) [![devDependencies](https://david-dm.org/assemble/assemble.png/dev-status.png)](https://david-dm.org/assemble/assemble) ```js [%= _.david() %] // => [![dependencies](https://david-dm.org/assemble/assemble.png)](https://david-dm.org/assemble/assemble) // => [![devDependencies](https://david-dm.org/assemble/assemble/dev-status.png)](https://david-dm.org/assemble/assemble#info=devDependencies) ``` ## drone ```js [%= _.drone() %] // => [![](https://drone.io/assemble/assemble/status.png)](https://drone.io/assemble/assemble/latest) ``` ## fury ```js [%= _.fury() %] // => [![NPM version](https://badge.fury.io/assemble/assemble.png)](http://badge.fury.io/assemble/assemble) ``` ## nodei [![NPM](https://nodei.co/npm/assemble.png)](https://nodei.co/npm/assemble/) ```js [%= _.nodei() %] [%= _.nodei('downloads,stars', '6') %] [%= _.nodei('mini') %] [%= _.nodei('compact') %] [%= _.nodei('compact,downloads,mini,stars') %] [%= _.nodei('compact,downloads,stars') %] [%= _.nodei('compact,downloads,stars', 6) %] ``` **examples** {%= _.nodei() %} {%= _.nodei('mini') %} {%= _.nodei('compact') %} {%= _.nodei('downloads,stars', '6') %} {%= _.nodei('compact,downloads,mini,stars') %} {%= _.nodei('compact,downloads,stars') %} {%= _.nodei('compact,downloads,stars', 6) %} ## travis [![Build Status](https://travis-ci.org/assemble/assemble.png?branch=master)](https://travis-ci.org/assemble/assemble) ```js [%= _.travis() %] // => [![Build Status](https://travis-ci.org/assemble/assemble.png?branch=master)](https://travis-ci.org/assemble/assemble) ```