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

Go to file

Amio 8aafb96f8b 2.0.0		2018-07-16 22:34:30 +08:00
bench	Add options: {style: 'flat'}	2018-07-15 17:22:56 +08:00
lib	Tweak badge shadow	2018-07-16 22:10:56 +08:00
preview	Fix typo in preview.md	2018-07-16 22:14:45 +08:00
test	Breaking: simplify options arguments	2018-07-16 21:58:23 +08:00
.gitignore	Initial commit	2018-05-29 16:53:54 +08:00
.npmignore	Organize folders	2018-07-15 16:19:44 +08:00
.travis.yml	Add .travis.yml	2018-06-23 20:13:47 +08:00
README.md	Breaking: simplify options arguments	2018-07-16 21:58:23 +08:00
package-lock.json	2.0.0	2018-07-16 22:34:30 +08:00
package.json	2.0.0	2018-07-16 22:34:30 +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>, optional
  style: 'flat'     // 'flat' or undefined, optional
})

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:

[classic] style, long params  x 1,071,083 ops/sec ±0.82% (89 runs sampled)
[classic] style, full params  x 1,332,181 ops/sec ±0.80% (92 runs sampled)
   [flat] style, long params  x 1,145,825 ops/sec ±0.73% (94 runs sampled)
   [flat] style, full params  x 1,416,453 ops/sec ±0.69% (91 runs sampled)

README.md Unescape Escape