# node-banner

> Easily integrate ASCII flavoured banners to your CLI tool

Latest version **1.4.0** (published 2019-12-21) · GNU GPL V3 license · 0 weekly downloads

## Install

```sh
npm install node-banner
pnpm add node-banner
yarn add node-banner
bun add node-banner
```

## 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.0 |
| Published | 2019-12-21 |
| First published | 2019-06-07 |
| Weekly downloads | 0 |
| License | GNU GPL V3 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 38.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 22 |
| Author | James George |
| Maintainers | jamesgeorge007 |
| Keywords | banner, nodejs, ascii, art, javascript, cli-library |

## Links

- npm: https://www.npmjs.com/package/node-banner
- Repository: https://github.com/jamesgeorge007/node-banner
- Homepage: https://github.com/jamesgeorge007/node-banner#readme
- Issues: https://github.com/jamesgeorge007/node-banner/issues
- npm.io page: https://npm.io/package/node-banner

## Dependencies (2)

- [kleur](https://npm.io/package/kleur.md) ^3.0.3
- [figlet](https://npm.io/package/figlet.md) ^1.2.3

## Alternatives

- [d3-force-3d](https://npm.io/package/d3-force-3d.md) — 1.0M weekly downloads
- [ng2-charts](https://npm.io/package/ng2-charts.md) — 486.8K weekly downloads
- [@arcgis/core](https://npm.io/package/@arcgis/core.md) — 257.8K weekly downloads
- [react-sparklines](https://npm.io/package/react-sparklines.md) — 249.3K weekly downloads
- [react-native-gifted-charts](https://npm.io/package/react-native-gifted-charts.md) — 182.3K weekly downloads

## Recent versions

- 1.4.0 (latest) — 2019-12-21
- 1.3.2 — 2019-07-02
- 1.3.1 — 2019-07-02
- 1.3.0 — 2019-07-02
- 1.2.2 — 2019-06-08
- 1.2.1 — 2019-06-08
- 1.2.0 — 2019-06-08
- 1.1.8 — 2019-06-07
- 1.1.7 — 2019-06-07
- 1.1.5 — 2019-06-07
- 1.1.0 — 2019-06-07
- 1.0.6 — 2019-06-07
- 1.0.5 — 2019-06-07
- 1.0.4 — 2019-06-07
- 1.0.2 — 2019-06-07
- … 1 more at https://npm.io/package/node-banner/versions

## README

[![Build Status](https://travis-ci.com/jamesgeorge007/node-banner.svg?branch=master)](https://travis-ci.com/jamesgeorge007/node-banner)

<p align="center">
	<img src="https://i.imgur.com/9CVBorr.png" alt="node-banner">
</p>

Easily integrate ASCII flavoured banner to your CLI utility.

## Usage

```md
$ npm install --save node-banner
```

```js
const showBanner = require('node-banner');

(async () => {
	await showBanner('The Title', 'This is a suitable tagline');
})();

```

![Demo](https://i.imgur.com/btVf53N.png)

## API

### showBanner(title, [tagLine], [titleColor], [tagLineColor])

- title: Name of the utility.
- tagLine: A suitable tagline.
- titleColor: Override the default title-color that defaults to red.
- tagLineColor: Override the default tagline-color that defaults to yellow.

## Testing

```bash
 $ npm test
```

## License

[GNU GPL V3](https://github.com/jamesgeorge007/node-banner/blob/master/LICENSE)

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