Fast handcraft svg badge generator library . Used on badgen.net.

Go to file

Amio a4b7359483 1.1.4		2018-07-15 02:22:48 +08:00
bench	Remove "short params" bench	2018-07-15 01:49:35 +08:00
lib	Refine text position	2018-07-15 02:21:32 +08:00
test	Update preview	2018-07-11 13:40:30 +08:00
.gitignore	Initial commit	2018-05-29 16:53:54 +08:00
.npmignore	Update .npmignore	2018-07-01 16:28:08 +08:00
.travis.yml	Add .travis.yml	2018-06-23 20:13:47 +08:00
README.md	Remove "short params" bench	2018-07-15 01:49:35 +08:00
package-lock.json	1.1.4	2018-07-15 02:22:48 +08:00
package.json	1.1.4	2018-07-15 02:22:48 +08:00

README.md

badgen

Fast, handcraft, pure JavaScript badge generator.

⚡️ Fast (see benchmarks)
🌀 Zero dependency (compare with 11 deps for gh-badges which being used on shields.io)

Usage

npm package

npm install badgen

const badgen = require('badgen')

const svgString = badgen({
  subject: 'npm',   // <Text>
  status: 'v1.2.3', // <Text>
  color: 'blue'     // <Color RGB> or <Color Name>
})

Available color names:

Badge Service

https://badgen.now.sh/

Benchmarks

npm run bench on my iMac5K(Late 2014), 3.5G i5, with Node.js 10.5.0:

generate by long params  x 1,046,942 ops/sec ±0.61% (93 runs sampled)
generate by full params  x 1,266,881 ops/sec ±0.76% (91 runs sampled)

README.md Unescape Escape