README.md

spray-print

Colorised print

spray-print is a library that makes your console prints more vibrant using chalk.

This is a breif overview of the documentation. For more information go to https://aceius.gitbook.io

💾 Project setup

As a user:

npm install spray-print

As a dev:

First, clone the project to disk with the GitHub CLI, GitHub Desktop, or however you get your git repos. You will need to do this if you want to help develop or build from source.
In order to commit to the project or build the code, you will need the folowing installed:

• NodeJS (For easy testing I guess)
• npm (or yarn)
• Yarn (Run npm install yarn -g)

Then, install the rest of the dependencies with yarn.

npm install
# OR
yarn install

After cloning to disk, make your changes and then test with node test.js.

🔧 Useage

const print = require('print');

There are several types of printouts, and a custom one too:

print.println('Message');
print.warn('Warning');
print.error('Error');
print.success(':D');
print.custom('title','message');

You can append c to these function names to get an alternate style.

📜 Licencing

spray-print is licenced under the GNU GPL v3.