Skip to content

jamesgeorge007/node-banner

Repository files navigation

node-banner

Build Status

Easily integrate ASCII flavoured banner to your CLI utility.

Usage

$ npm install --save node-banner
const showBanner = require('node-banner');

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

Demo

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

 $ npm test

License

GNU GPL V3