doc-badges

Generates .md badges

$ npm install vigour-doc-badges

usage

var badges = require('vigour-doc-badges')
badges(<options>) // returns markdown for the requested badges

<options> is an object with keys corresponding to badge names (see available badges) and values the configuration for the badge

example

var badges = require('vigour-doc-badges')
badges({
  travis: {
    owner: 'vigour-io',
    repo: 'doc-badges'
  },
  standard: {
    style: 'shield'
  },
  npm: {}
})
/*
[![Build Status](https://travis-ci.org/vigour-io/doc-badges.svg?branch=master)](https://travis-ci.org/vigour-io/doc-badges)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
[![npm version](https://badge.fury.io/js/vigour-doc-badges.svg)](https://badge.fury.io/js/vigour-doc-badges)
*/

Available badges

travis

var options = {
  owner: '<githubOwner>',
  repo: '<githubRepo>',
  branch: '<branchName>'
}

• owner : GitHub owner name
• repo : GitHub repository name
• branch : GitHub branch name

standard

var options = {
  style: '<style>'
}

• style : one of the following, defaults to 'shield'
  • 'shield':
  • 'badge':

npm

var options = {
  package: '<packageName>'
}

• package : npm package name

coveralls

var options = {
  owner: '<githubOwner>', // vigour-io
  repo: '<githubRepo>', // doc-badges
  branch: '<branchName>' // master
}

Important! In order to configure coveralls check out docs!

...

more coming soon, stay tuned!