Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

badging

Package Overview
Dependencies
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

badging

Index of frequently used badges for NPM

  • 0.0.4
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

badging

Index of frequently used badges for NPM

total downloads of badging badging's License latest version of badging coverage status of github.com/YounGoat/nodejs.badging dependencies of github.com/YounGoat/nodejs.badging devDependencies of github.com/YounGoat/nodejs.badging build status of github.com/YounGoat/nodejs.badging star github.com/YounGoat/nodejs.badging

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');

// The arguments may differ (in number and content) from medal type to type.
var badge = badging.npm.version('npm-package-name');

// Generate html.
var html = badge.toHtml();

// Generate markdown.
var markdown = badge.toMarkdown();

// The returned info object always contains two properties: href & src.
// Generate text at will.
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:

  • year
  • month
  • week
  • total

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.

Keywords

FAQs

Package last updated on 29 May 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc