shi

shields

Generate shields for your current project's README

Showing:

Popularity

Downloads/wk

9

GitHub Stars

8

Maintenance

Last Commit

5yrs ago

Contributors

2

Package

Dependencies

3

Size (min+gzip)

1.2KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

shields

Build Status Dependency Status

Generate shields for your current project's README.md.

Example

From the command-line:

$ shields travis gemnasium
[![Build Status][travis-svg]][travis]
[![Dependency Status][gemnasium-svg]][gemnasium]

   [travis]: https://travis-ci.org/KenanY/shields
   [travis-svg]: https://img.shields.io/travis/KenanY/shields.svg
   [gemnasium]: https://gemnasium.com/KenanY/shields
   [gemnasium-svg]: https://img.shields.io/gemnasium/KenanY/shields.svg

Or from the API:

var shields = require('shields')();

shields('travis', {
  repo: 'KenanY/shields'
});
// => {
// =>   text: 'Build status',
// =>   image: 'https://img.shields.io/travis/KenanY/shields.svg?style=flat',
// =>   link: 'https://travis-ci.org/KenanY/shields'
// => }

Installation

For the command-line executable:

$ npm install -g shields

For the API:

$ npm install shields

API

var shielder = require('shields');

var shields = shielder(opts)

  • opts.style is the style of the shield. The available styles are: flat (the default one), flat-square and plastic.
var shields = shielder({
  style: 'plastic'
})

shields(service, opts)

  • service is a String representing the service for which the shield will be created. Currently supported values are: npm, travis, coveralls, climate, deps, devdeps, peerdeps, gemnasium.
  • opts.repo is the GitHub repo targeted by the shield. For the current repo the value would be KenanY/shields.
  • opts.branch is the branch name for which the shield is created.
  • opts.npmName is the npm name of the package for which the shield is created. This value is currently required only by the npm shield.

The shields function returns an Object obj which has three keys:

  • obj.image is a String link to the SVG of the shield for String service
  • obj.link is a String link to the project page of repo on the website of service
  • obj.text is a String label for the service

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100