## Description
An extensive JavaScript Library to integrate the power of (de)Motivator into your webapp.
## Use Cases
- Casually throw shade at your users.
- Need a random insult
- Just been roasted, and you dont feel like visiting [(de)Motivator](https://porkyproductions.github.io/deMotivator)
- You feel as if your userbase's ego is far too high
## Installation
### via `npm`
Install the `demotivator` package
```bash
npm i demotivator
```
Include the `demotivator` package in your `package.json` (this should be done automatically by npm)
In your javascript file, (de)Motivator
```javascript
import deMotivator from 'demotivator';
```
## Usage
`generateInsult` will return a random insult. Run this function anytime you need to refresh the random insult. Takes one argument, the array of insults to generate from.
`insultAt`returns the insult at the specified point in the array. Takes 2 arguments, the first of which is the spot in the array to return, and the second is the array to pick from.
`insults` gives you access to the full array of insults. Do with it as you wish.
`profaneInsults` gives you all of the profane, or "dirty" insults that come with the package.
`createArray` creates an array of insults based on a configuration of your choosing
`deMotivator` Contains all the functions and properties of the deMotivator.
`DeMotivator` A class version of the `deMotivator` object
## Examples
This is an example for a basic web page integrated with (de)Motivator.js
### HTML
```html
Insult will appear here
``` ### JavaScript ```javascript // src/index.js // As always, you'll need a module bundler like webpack or rollup to compile your code into a form the browser can understand. import { generateInsult } from 'demotivator'; const insult = document.getElementById('insult'); button.addEventListener('click', () => insult.innerHTML = generateInsult(createArray({ original: true, profane: false, )); ``` ## Update Schedule DMV.js will follow the same update schedule as [(de)Motivator](https://porkyproductions.github.io/deMotivator), with a release every 6-8 months. ## License We are licenced under the Apache-2.0 licnse. Please see [LICENSE](LICENSE) for more information.