| 1 | # Dadojs
|
| 2 |
|
| 3 | Tool for rolling a random six-sided die
|
| 4 |
|
| 5 | [![NPM Version][npm-version-image]][npm-url]
|
| 6 | [![NPM Install Size][npm-install-size-image]][npm-install-size-url]
|
| 7 | [![NPM Downloads][npm-downloads-image]][npm-downloads-url]
|
| 8 |
|
| 9 | ```js
|
| 10 | const dadojs = require('dadojs');
|
| 11 |
|
| 12 | const number = dadojs.lanzar();
|
| 13 | ```
|
| 14 |
|
| 15 | ## Installation
|
| 16 |
|
| 17 | This is a [Node.js](https://nodejs.org/en/) module available through the
|
| 18 | [npm registry](https://www.npmjs.com/).
|
| 19 |
|
| 20 | Before installing, [download and install Node.js](https://nodejs.org/en/download/).
|
| 21 | Node.js 0.10 or higher is required.
|
| 22 |
|
| 23 | If this is a brand new project, make sure to create a `package.json` first with
|
| 24 | the [`npm init` command](https://docs.npmjs.com/creating-a-package-json-file).
|
| 25 |
|
| 26 | Installation is done using the
|
| 27 | [`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
|
| 28 |
|
| 29 | ```console
|
| 30 | $ npm install dadojs
|
| 31 | ```
|
| 32 |
|
| 33 | ### Running Tests
|
| 34 |
|
| 35 | To run the test suite, first install the dependencies, then run `npm test`:
|
| 36 |
|
| 37 | ```console
|
| 38 | $ npm install
|
| 39 | $ npm test
|
| 40 | ```
|
| 41 |
|
| 42 | ## License
|
| 43 |
|
| 44 | [MIT](LICENSE)
|
| 45 |
|
| 46 | [npm-downloads-image]: https://badgen.net/npm/dm/dadojs
|
| 47 | [npm-downloads-url]: https://npmcharts.com/compare/dadojs?minimal=true
|
| 48 | [npm-install-size-image]: https://badgen.net/packagephobia/install/dadojs
|
| 49 | [npm-install-size-url]: https://packagephobia.com/result?p=dadojs
|
| 50 | [npm-url]: https://npmjs.org/package/dadojs
|
| 51 | [npm-version-image]: https://badgen.net/npm/v/dadojs |
| \ | No newline at end of file |