badging
Index of frequently used badges for NPM
Get Started
Install the package as one of dependencies of your package:
npm install --save badging
Then, require it and get medal info you need. E.g.
const badging = require('badging');
var badge = badging.npm.version('npm-package-name');
var html = badge.toHtml();
var markdown = badge.toMarkdown();
var text = `<a href="${badge.href}"><img src="${badge.src}"/></a>`;
Embodied Badges
Badges embodied by badging are classified into different groups. Same or similiar arguments are required on creating badges in same group. E.g., both badging.npm.license()
and badging.npm.version()
require argument named packageName
. Up to now, there are 2 groups available:
- npm
based on packageName. - github
based on userName (of github.com), repoName and branch.
npm.downloads
var badge = badging.npm.downloads(packageName, unit);
The unit
may be one of:
Powered by Shields IO.
npm.license
var badge = badging.npm.license(packageName);
Powered by Shields IO.
npm.version
var badge = badging.npm.version(packageName);
Powered by Shields IO.
github.coveralls
var badge = badging.github.coveralls(userName, repoName);
Powered by Coveralls.
github.dependencies
var badge = badging.github.dependencies(userName, repoName);
Powered by Davids.
github.devDependencies
var badge = badging.github.devDependencies(userName, repoName);
Powered by Davids.
github.star
var badge = badging.github.star(userName, repoName);
Powered by Shields IO.
github.travis
var badge1 = badging.github.travis(userName, repoName);
var badge2 = badging.github.travis(userName, repoName, branch);
Powered by Travis-CI.