mirror
/
badgen
kopia lustrzana https://github.com/badgen/badgen
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność
Fast handcraft svg badge generator library . Used on badgen.net.
101 Commity
5 Gałęzie
46 Tagi
907 KiB
JavaScript 90.9%
TypeScript 9.1%
 
 
Go to file
Amio e42cca0ea7 Revert "Add codecov report to travis.yml" 
This reverts commit c378d1f18b.
 		2018-07-18 15:18:35 +08:00
bench Update benchmark with new options format 2018-07-18 13:54:25 +08:00
lib Improve error handling 2018-07-18 13:59:40 +08:00
preview Fix typo in preview.md 2018-07-16 22:14:45 +08:00
test Add test coverage report 2018-07-18 14:11:11 +08:00
.gitignore Add test coverage report 2018-07-18 14:11:11 +08:00
.npmignore Organize folders 2018-07-15 16:19:44 +08:00
.travis.yml Revert "Add codecov report to travis.yml" 2018-07-18 15:18:35 +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 Add test coverage report 2018-07-18 14:11:11 +08:00

README.md

badgen npm-version install size

Fast, handcraft, pure JavaScript badge generator.

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)

License

ISC