Skip to content

Latest commit

 

History

History
82 lines (58 loc) · 2.3 KB

README.md

File metadata and controls

82 lines (58 loc) · 2.3 KB

js-games

Generated by OSS Project Generator.

Travis Status AppVeyor Status CircleCI Status Coveralls Status NPM Version License

An awesome project

Long description.

Installation

Install package

$ npm install --save js-games

Usage

Say It works!

const lib = require('js-games');

lib.hello((err, message) => {
  if (err) return console.error(err);

  console.log(message);
});

Development

  • Cloning the repo
$ git clone https://github.com/hrsalles/js-games.git
  • Installing dependencies
$ npm install
  • Running scripts
Action Usage
Starting development mode npm start
Linting code npm run lint
Running unit tests npm run jest
Running code coverage npm run coverage
Running lint + tests npm test
Sending coverage results to Coveralls.io npm run coveralls

Author

Max Salles

License

MIT