# badge-up

> A module that produces hot badges without the need of Cairo

Latest version **3.0.0** (published 2020-04-21) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install badge-up
pnpm add badge-up
yarn add badge-up
bun add badge-up
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2020-04-21 |
| First published | 2016-04-26 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10.0.0 |
| Dependencies | 3 |
| Unpacked size | 16.4 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 9 |
| Author | St. John Johnson |
| Maintainers | davglass, fenrirunbound, petey, screwdriver, stjohnjohnson |
| Keywords | badge, yahoo |

## Links

- npm: https://www.npmjs.com/package/badge-up
- Repository: https://github.com/yahoo/badge-up
- Issues: https://github.com/yahoo/badge-up/issues
- npm.io page: https://npm.io/package/badge-up

## Dependencies (3)

- [dot](https://npm.io/package/dot.md) ^1.1.3
- [svgo](https://npm.io/package/svgo.md) ^1.3.2
- [css-color-names](https://npm.io/package/css-color-names.md) ~1.0.1

## Recent versions

- 3.0.0 (latest) — 2020-04-21
- 2.4.0 — 2020-03-26
- 2.3.0 — 2017-01-31
- 2.2.0 — 2016-06-03
- 2.0.1 — 2016-04-26
- 2.0.0 — 2016-04-26

## README

# badge-up

[![npm](https://img.shields.io/npm/v/badge-up.svg?maxAge=2592000)](https://www.npmjs.com/package/badge-up)
[![downloads](https://img.shields.io/npm/dt/badge-up.svg?maxAge=2592000)](https://www.npmjs.com/package/badge-up)
[![build](https://cd.screwdriver.cd/pipelines/62/badge?maxAge=2592000)](https://cd.screwdriver.cd/pipelines/62)
[![coverage](https://coveralls.io/repos/github/yahoo/badge-up/badge.svg)](https://coveralls.io/github/yahoo/badge-up)

This is a simple library that generates SVG badges without Cairo.


## Install

`npm install badge-up`


## V1 Usage

```js
const badge = require('badge-up');
badge('batman', 'component', badge.colors.green, function (error, svg) {
    // some callback
});
```

Produces: ![example](https://cdn.rawgit.com/yahoo/badge-up/master/test/testData/good.svg)

The color argument can be a CSS color, or one of the specially named colors
found in `badge.colors`.

You can alternatively use the returned `Promise`:

```js
const badge = require('badge-up');
(async () => {
try {
    const svg = await badge('batman', 'component', badge.colors.green);
} catch (error) {
    //
}
}());
```

## V2 Usage

With this API you can create arbitrary badges with an arbitrary number of sections.

Each section is an array. The first element is the text to show, and the rest
of the (optional) elements are attributes to apply to the text. If there are no
attributes then a single string (instead of an array of one element) can be
passed instead.

The following attributes are supported:

* `{hex}{hex}{hex}{hex}{hex}{hex}` six hexadecimal characters or `{css-color-name}` a named CSS color,
    either of which is used to color the section
* `s{{hex}{hex}{hex}{hex}{hex}{hex}}` six hexadecimal characters or `s{css-color-name}` a named CSS color,
    either of which is used to color stroke the section, e.g. `s{d3d3d3}`

The default color for the first section is `696969` and `d3d3d3` for subsequent sections.

Any section can have mulitple lines by putting newlines in its text.

```js
const badge = require('badge-up');
const sections = [
    'foo/far;fun',
    [ 'bar\nbaz', 'orange'],
    [ 'mork "mindy"', 'olive', 's{white}'],
    [ '<∀>', 'moccasin']
];
badge.v2(sections, function (error, svg) {
    // some callback
});
```

Produces: ![example](https://cdn.rawgit.com/yahoo/badge-up/master/test/testData/v2-example.svg)

You can also use the returned `Promise`:

```js
const badge = require('badge-up');
const sections = [
    'foo/far;fun',
    [ 'bar\nbaz', 'orange'],
    [ 'mork "mindy"', 'olive', 's{white}'],
    [ '<∀>', 'moccasin']
];

(async () => {
try {
    const svg = await badge.v2(sections);
} catch (error) {
  //
}
}());
```

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