npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

badging

v0.0.5

Published

Index of frequently used badges for NPM

Downloads

140

Readme

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

Links

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.