happy-valentines

Simple module to show your love on this Valentine's Day.

Table of Contents

• Installation
• Usage
• Development
• Contributing
• Motivation
• License
• Credits

Installation

Node

$ npm install --save happy-valentines

CLI

$ npm install -g happy-valentines

Usage

Send this project to whom you love and as soon as the person installs and runs, it will wish that special person a Happy Valentine's Day.

Node

const valentines = require('happy-valentines');
 
valentines();
 
 
/* =>
           LoveLoveLov                eLoveLoveLo
       veLoveLoveLoveLove          LoveLoveLoveLoveLo
    veLoveLoveLoveLoveLoveL      oveLoveLoveLoveLoveLove
   LoveLoveLoveLoveLoveLoveL    oveLoveLoveLoveLoveLoveLo
  veLoveLoveLoveLoveLoveLoveL  oveLoveLoveLoveLoveLoveLove
  LoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLove
  LoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLove
   LoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLo
   veLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLove
   veLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLove
     LoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLo
      veLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLove
        LoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLo
          veLoveLoveLoveLoveLoveLoveLoveLoveLove
            LoveLoveLoveLoveLoveLoveLoveLoveLo
              veLoveLoveLoveLoveLoveLoveLove
                LoveLoveLoveLoveLoveLoveLo
                   veLoveLoveLoveLoveLo
                       veLoveLoveLo
                            ve
 
  Happy Valentine's Day, dear Matheus Brasil.
 
*/

CLI

$ happy-valentines

Options

Option	Description
--help	Shows project description and how to use it.
--version	Displays the current version.

Development

All the tasks needed for development automation are defined in the package.json scripts property and can be run via:

npm run <command>

Here is a summary of all the commands:

Command	Description
compile	Runs the Livescript compiler on the source.
test	Runs Mocha in BDD mode.
build	Runs both compile and test commands.

Contributing

Contributions are very welcome! If you'd like to contribute, these guidelines may help you.

Motivation

You know what they say: love is in the air

¯\_(ツ)_/¯

License

happy-valentines is distributed under the MIT License, available in this repository. All contributions are assumed to be also licensed under the MIT License.

Credits

Part of the hearts art was taken from AsciiWorld.com.