diff --git a/README.md b/README.md index 6b9e1dd..e2cc080 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,8 @@ -# IN DEVELOPMENT - -[![npm Downloads Shield](https://img.shields.io/npm/dm/rpg-dice-js?style=flat-square&logo=npm)]() -[![Stars Shield](https://img.shields.io/github/stars/Mateo-Wallace/rpg-dice-js.svg?style=flat-square&color=blue&logo=github)](https://github.com/Mateo-Wallace/rpg-dice-js/stargazers) -[![Forks Shield](https://img.shields.io/github/forks/Mateo-Wallace/rpg-dice-js.svg?style=flat-square&logo=github)](https://github.com/Mateo-Wallace/rpg-dice-js/network/members) -[![Contributors Shield](https://img.shields.io/github/contributors/Mateo-Wallace/rpg-dice-js.svg?style=flat-square&color=success&logo=github)](https://github.com/Mateo-Wallace/rpg-dice-js/graphs/contributors) -[![License Shield](https://img.shields.io/github/license/Mateo-Wallace/rpg-dice-js.svg?style=flat-square)](https://github.com/Mateo-Wallace/rpg-dice-js/blob/main/LICENSE) -[![LinkedIn Shield](https://img.shields.io/badge/LinkedIn-555555?style=flat-square&logo=linkedin)](https://www.linkedin.com/in/mateo-wallace/) +[![npm Downloads Shield](https://img.shields.io/npm/dt/@mateo-wallace/rpg-dice-js?style=flat-square&logo=npm)](https://www.npmjs.com/package/@mateo-wallace/rpg-dice-js) [![Stars Shield](https://img.shields.io/github/stars/Mateo-Wallace/rpg-dice-js.svg?style=flat-square&color=blue&logo=github)](https://github.com/Mateo-Wallace/rpg-dice-js/stargazers) [![Forks Shield](https://img.shields.io/github/forks/Mateo-Wallace/rpg-dice-js.svg?style=flat-square&logo=github)](https://github.com/Mateo-Wallace/rpg-dice-js/network/members) [![Contributors Shield](https://img.shields.io/github/contributors/Mateo-Wallace/rpg-dice-js.svg?style=flat-square&color=success&logo=github)](https://github.com/Mateo-Wallace/rpg-dice-js/graphs/contributors) [![License Shield](https://img.shields.io/github/license/Mateo-Wallace/rpg-dice-js.svg?style=flat-square)](https://github.com/Mateo-Wallace/rpg-dice-js/blob/main/LICENSE) [![LinkedIn Shield](https://img.shields.io/badge/LinkedIn-555555?style=flat-square&logo=linkedin)](https://www.linkedin.com/in/mateo-wallace/)
@@ -28,12 +21,18 @@ · View GitHub · - View npm + View npm · Report Bug

+ + +``` +npm i @mateo-wallace/rpg-dice-js +``` +
@@ -59,7 +58,7 @@

- Example of Working Discord App + example dice roller in effect

@@ -68,25 +67,21 @@ rpg-dice-js is an npm package that allows a user to send an input to a `roll()` Main Features: -- [Settings]() adjustment within a `Dice` model -- [User input]() of all kinds accepted -- [Dice response object]() with robust information such as `input`, `result`, `total`, etc... +- [Settings](https://mateo-wallace.github.io/rpg-dice-js/diceclass/#settings) adjustment within a `Dice` model +- [User input](https://mateo-wallace.github.io/rpg-dice-js/rollfunction/#valid-inputs) of all kinds accepted +- [Dice response object](https://mateo-wallace.github.io/rpg-dice-js/rollfunction/#output) with robust information such as `input`, `result`, `total`, etc... -Explore the [documentation]() for further information on how to download and use rpg-dice-js. - -

(back to top)

+See the [Quick Start](https://mateo-wallace.github.io/rpg-dice-js/quickstart/) guide to see how to implement rpg-dice-js into your code! ### Built With -[![JavaScript Shield](https://img.shields.io/badge/JavaScript-F7DF1E?&style=for-the-badge&logo=javascript&logoColor=272727)](https://developer.mozilla.org/en-US/docs/Web/JavaScript) -[![NPM Shield](https://img.shields.io/badge/NPM-333333?&style=for-the-badge&logo=npm&logoColor=white)](https://www.npmjs.com/) -[![Node.js Shield](https://img.shields.io/badge/Node.js-339933?&style=for-the-badge&logo=node.js&logoColor=white)](https://nodejs.org/en/) +[![JavaScript Shield](https://img.shields.io/badge/JavaScript-F7DF1E?&style=flat-square&logo=javascript&logoColor=272727)](https://developer.mozilla.org/en-US/docs/Web/JavaScript) [![NPM Shield](https://img.shields.io/badge/NPM-333333?&style=flat-square&logo=npm&logoColor=white)](https://www.npmjs.com/) [![Node.js Shield](https://img.shields.io/badge/Node.js-339933?&style=flat-square&logo=node.js&logoColor=white)](https://nodejs.org/en/) ## Documentation -Visit the [rpg-dice-js docs](https://mateo-wallace.github.io/MP2-Discord-DumBot-V2/) for in depth descriptions on requiring the package, customizing the `Dice` class, calling the `roll()` function, and more. +Visit the [rpg-dice-js docs](https://mateo-wallace.github.io/rpg-dice-js/) for in depth descriptions on requiring the package, customizing the `Dice` class, calling the `roll()` function, and more.

(back to top)

diff --git a/img/exRoll.png b/img/exRoll.png new file mode 100644 index 0000000..60fe032 Binary files /dev/null and b/img/exRoll.png differ