# badging

> Index of frequently used badges for NPM

Latest version **0.0.5** (published 2018-01-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install badging
pnpm add badging
yarn add badging
bun add badging
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2018-01-09 |
| First published | 2017-05-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | youngoat@163.com |
| Maintainers | youngoat |
| Keywords | badge, npm, travis, license |

## Links

- npm: https://www.npmjs.com/package/badging
- Repository: https://github.com/YounGoat/nodejs.badging
- Homepage: https://github.com/YounGoat/nodejs.badging#readme
- Issues: https://github.com/YounGoat/nodejs.badging/issues
- npm.io page: https://npm.io/package/badging

## Recent versions

- 0.0.5 (latest) — 2018-01-09
- 0.0.4 — 2017-05-29
- 0.0.2 — 2017-05-26
- 0.0.1 — 2017-05-25

## README

#	badging
__Index of frequently used badges for NPM__

[![total downloads of badging](https://img.shields.io/npm/dt/badging.svg)](https://www.npmjs.com/package/badging)
[![badging's License](https://img.shields.io/npm/l/badging.svg)](https://www.npmjs.com/package/badging)
[![latest version of badging](https://img.shields.io/npm/v/badging.svg)](https://www.npmjs.com/package/badging)
[![coverage status of github.com/YounGoat/nodejs.badging](https://img.shields.io/coveralls/YounGoat/nodejs.badging/master.svg)](https://coveralls.io/github/YounGoat/nodejs.badging2?branch=master)
[![dependencies of github.com/YounGoat/nodejs.badging](https://david-dm.org/YounGoat/nodejs.badging/status.svg)](https://david-dm.org/YounGoat/nodejs.badging)
[![devDependencies of github.com/YounGoat/nodejs.badging](https://david-dm.org/YounGoat/nodejs.badging/dev-status.svg)](https://david-dm.org/YounGoat/nodejs.badging?type=dev)
[![build status of github.com/YounGoat/nodejs.badging](https://travis-ci.org/YounGoat/nodejs.badging.svg?branch=master)](https://travis-ci.org/YounGoat/nodejs.badging)
[![star github.com/YounGoat/nodejs.badging](https://img.shields.io/github/stars/YounGoat/nodejs.badging.svg?style=social&label=Star)](https://github.com/YounGoat/nodejs.badging/stargazers)

##	Links

*	[CHANGE LOG](./CHANGELOG.md)
*	[Homepage](https://github.com/YounGoat/nodejs.badging)

##	Get Started

Install the package as one of dependencies of your package:

```bash
npm install --save badging
```

Then, require it and get medal info you need. E.g.

```javascript
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

```javascript
var badge = badging.npm.downloads(packageName, unit);
```

The `unit` may be one of:  
*	year
*	month
*	week
*	total

Powered by [Shields IO](http://shields.io).

###	npm.license

```javascript
var badge = badging.npm.license(packageName);
```

Powered by [Shields IO](http://shields.io).

###	npm.version

```javascript
var badge = badging.npm.version(packageName);
```

Powered by [Shields IO](http://shields.io).

###	github.coveralls

```javascript
var badge = badging.github.coveralls(userName, repoName);
```

Powered by [Coveralls](https://coveralls.io).

###	github.dependencies

```javascript
var badge = badging.github.dependencies(userName, repoName);
```

Powered by [Davids](https://david-dm.org).

###	github.devDependencies

```javascript
var badge = badging.github.devDependencies(userName, repoName);
```

Powered by [Davids](https://david-dm.org).

###	github.star

```javascript
var badge = badging.github.star(userName, repoName);
```

Powered by [Shields IO](http://shields.io).

###	github.travis

```javascript
var badge1 = badging.github.travis(userName, repoName);
var badge2 = badging.github.travis(userName, repoName, branch);
```

Powered by [Travis-CI](https://travis-ci.org).

---
_Source: https://npm.io/package/badging · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._