badgs

Badges generator

  • badgs

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
badgs
411.1.16 years ago7 years agoMinified + gzip package size for badgs in KB

Readme

badgs
npm license github-issues travis-status coveralls Commitizen friendly
Badges generator

Features

  • Generates badges like any you can see above.
  • No dependecies.
  • Small and possibly work even on client.
  • Easy to write own templating function.
  • Well tested.
  • Express/Connect middleware.

Install

npm i badgs

// OR for CLI usage
npm i -g badgs

Usage

CLI

badgs subject status color [-o output.svg]

// Examples
badgs build success green // File will be saved inbuild-success-green.svg
badgs build success green -o custom_file_name.svg

As module

import Badgs from 'badgs';

const badgs = new Badgs();

console.log(badgs.render('status', 'subject', 'red'));

Author

Ideas/Templates — stolen from here and here.
Stanislav Sysoev http://github.com/d4rkr00t

License

  • MIT : http://opensource.org/licenses/MIT

Contributing

Contributing are highly welcome! This repos is commitizen friendly — please read about it here.