https://github.com/jamesgeorge007/node-banner

Easily integrate ASCII flavored banners to your CLI tool
https://github.com/jamesgeorge007/node-banner

banner banner-generator command-line-tool hacktoberfest hacktoberfest2020 javascript javascript-library nodejs

Last synced: 3 days ago
JSON representation

Easily integrate ASCII flavored banners to your CLI tool

• Host: GitHub
• URL: https://github.com/jamesgeorge007/node-banner
• Owner: jamesgeorge007
• License: gpl-3.0
• Created: 2019-06-07T02:24:28.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-03-03T00:44:52.000Z (over 1 year ago)
• Last Synced: 2024-07-11T23:29:39.564Z (4 months ago)
• Topics: banner, banner-generator, command-line-tool, hacktoberfest, hacktoberfest2020, javascript, javascript-library, nodejs
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/node-banner
• Size: 151 KB
• Stars: 22
• Watchers: 2
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


	



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

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)