Skip to content

Latest commit

 

History

History
86 lines (59 loc) · 1.81 KB

README.md

File metadata and controls

86 lines (59 loc) · 1.81 KB
Raw

gh-badges

npm version npm license

Installation

npm install gh-badges

Usage

On the console

npm install -g gh-badges
badge build passed :green .png > mybadge.png

As a library

const { BadgeFactory } = require('gh-badges')

const bf = new BadgeFactory()

const format = {
  text: ['build', 'passed'],
  colorscheme: 'green',
  template: 'flat',
}

const svg = bf.create(format)

Format

The format is the following:

{
  text: [ 'build', 'passed' ],  // Textual information shown, in order

  format: 'svg',  // Also supports json

  colorscheme: 'green',
  // or ...
  colorA: '#555',
  colorB: '#4c1',

  // See templates/ for a list of available templates.
  // Each offers a different visual design.
  template: 'flat',
}

See also

Defaults

If you want to use a colorscheme, head to lib/colorscheme.json. Each scheme has a name and a CSS/SVG color for the color used in the first box (for the first piece of text, field colorA) and for the one used in the second box (field colorB).

"green": {
  "colorB": "#4c1"
}

Both colorA and colorB have default values. Usually, the first box uses the same dark grey, so you can rely on that default value by not providing a "colorA" field (such as above).

You can also use the "colorA" and "colorB" fields directly in the badges if you don't want to make a color scheme for it. In that case, remove the "colorscheme" field altogether.