flame-game

FLAME

Friends, Lovers, Affectionate, Marriage, Enemies

Flame game for the command line and Node. Requires Node (8.x or later). (How To Play).

Usage

As Module

1. Install the package using npm or Yarn

npm i flame-game
# or 
yarn add flame-game

1. Import the module

const flame = require('flame-game');

1. Pass input to it

// Two strings
flame('Joe', 'Missy');
 
// or an object
flame({
  firstName: 'Joe',
  secondName: 'Missy'
});

Returned data:

{
  relationship: 'affectionate', // result of the algorithm
  firstName: 'Joe',             // the original name 1
  secondName: 'Missy'           // the original name 2
}

In the CLI

1. Install the program globally

npm i -g flame-game

1. Run flame and enter some input.

Contribution

Linting:

yarn lint

Unit tests:

yarn test

License

MIT