# shieldman

> Badges creator

Latest version **1.4.1** (published 2021-04-14) · MIT license · 0 weekly downloads

## Install

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

## 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 | 1.4.1 |
| Published | 2021-04-14 |
| First published | 2016-05-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10 |
| Dependencies | 0 |
| Unpacked size | 8.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Zoltan Kochan |
| Maintainers | zkochan |
| Keywords | badge, shield |

## Links

- npm: https://www.npmjs.com/package/shieldman
- Repository: https://github.com/zkochan/shieldman
- Homepage: https://github.com/zkochan/shieldman#readme
- Issues: https://github.com/zkochan/shieldman/issues
- npm.io page: https://npm.io/package/shieldman

## Recent versions

- 1.4.1 (latest) — 2021-04-14
- 1.4.0 — 2019-03-19
- 1.3.0 — 2019-03-16
- 1.2.0 — 2016-10-22
- 1.1.0 — 2016-05-22
- 1.0.1 — 2016-05-16
- 1.0.0 — 2016-05-16

## README

# shieldman

> Badges creator

<!--@shields.flatSquare('npm', 'travis', 'coveralls')-->
[![npm version](https://img.shields.io/npm/v/shieldman.svg?style=flat-square)](https://www.npmjs.com/package/shieldman) [![Build Status](https://img.shields.io/travis/zkochan/shieldman/master.svg?style=flat-square)](https://travis-ci.org/zkochan/shieldman) [![Coverage Status](https://img.shields.io/coveralls/zkochan/shieldman/master.svg?style=flat-square)](https://coveralls.io/r/zkochan/shieldman?branch=master)
<!--/@-->

## Installation

```sh
npm i -S shieldman
```

## Usage

<!--@example('example.js')-->
```js
'use strict'
const shieldman = require('shieldman')

const shield = shieldman('travis', { repo: 'zkochan/shieldman' })

console.log(shield)
//> { text: 'Build Status',
//    link: 'https://travis-ci.org/zkochan/shieldman',
//    image: 'https://img.shields.io/travis/zkochan/shieldman.svg' }
```
<!--/@-->

## API

`shieldman(service, [opts])`

- `service` is a _String_ representing the service for which the shield will
  be created.
- `opts.style` is the style of the shield. The available styles are: flat (the
  default one), flat-square and plastic.
- `opts.repo` is the GitHub repo targeted by the shield. For the current repo
  the value would be `KenanY/shields`.
- `opts.branch` is the branch name for which the shield is created.
- `opts.npmName` is the npm name of the package for which the shield is
  created. This value is currently required only by the `npm` shield.

The `shieldman` function returns an _Object_ `obj` which has three keys:

- `obj.image` is a _String_ link to the SVG of the shield for _String_
  `service`
- `obj.link` is a _String_ link to the project page of `repo` on the website
  of `service`
- `obj.text` is a _String_ label for the `service`

## License

[MIT](./LICENSE) © [Zoltan Kochan](http://kochan.io)

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