# tiny-badge-maker

> Lightweight svg badge maker

Latest version **1.1.1** (published 2021-02-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install tiny-badge-maker
pnpm add tiny-badge-maker
yarn add tiny-badge-maker
bun add tiny-badge-maker
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: insecure dependencies; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2021-02-05 |
| First published | 2021-01-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >= 14 |
| Dependencies | 2 |
| Unpacked size | 225.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Selwyn |
| Maintainers | devoorhoede |
| Keywords | badge, svg, shields |

## Links

- npm: https://www.npmjs.com/package/tiny-badge-maker
- Repository: https://github.com/voorhoede/tiny-shields
- Homepage: https://github.com/voorhoede/tiny-shields#readme
- Issues: https://github.com/voorhoede/tiny-shields/issues
- npm.io page: https://npm.io/package/tiny-badge-maker

## Dependencies (2)

- [common-tags](https://npm.io/package/common-tags.md) github:zspecza/common-tags#pull/212/head
- [binary-search](https://npm.io/package/binary-search.md) ^1.3.6

## Recent versions

- 1.1.1 (latest) — 2021-02-05
- 1.1.0 — 2021-02-05
- 1.0.0 — 2021-01-27

## README

# Tiny Badge Maker
[![npm][npm-badge]][npm]

Create SVG badges following the [Shields badge specification](https://github.com/badges/shields/blob/5af5c480db/spec/SPECIFICATION.md).

`npm install tiny-badge-maker`

## API
### tinyBadgeMaker({ label, message, color, labelColor, horizontalPadding })

#### label
Type: `string`

The label text is used on the left side of the badge.

#### message
Type: `string`

The message text is used on the right side of the badge.

#### color
Type: `string`  
Default: `brightgreen`  
Options: `brightgreen`, `green`, `yellowgreen`, `yellow`, `orange`, `red`, `blue`, `grey`, `lightgrey`

Accepts a hex value like `#fff` or one of the options above.

#### labelColor
Type: `string`  
Default: `grey`  
Options: `brightgreen`, `green`, `yellowgreen`, `yellow`, `orange`, `red`, `blue`, `grey`, `lightgrey`

Accepts a hex value like `#fff` or one of the options above.

#### horizontalPadding
Type: `number`
Default: `5`

A positive number that is used as padding in pixels.

[npm]: https://npmjs.com/tiny-badge-maker
[npm-badge]: https://tiny-shields.voorhoede.workers.dev/service/npm/css-declaration-sorter

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