ehp-rates/README.md

ehp rates as a package

# ehp-rates

RuneScape EHP (Efficient Hours Played) experience rates as a module.

## Install

```
$ npm install ehp-rates
```

## Usage

```js
const rates = require('ehp-rates');

const { rs3 } = rates;
/*
  {
      main: {
        attack: ...
        defence: ...
      },
      skiller: {
        cooking: ...
        woodcutting: ...
      }
    }
  }
*/
```

## API

### `.<game>.<mode>.<skill>`

Returns an object with two arrays `thresholds` and `rates`. At skill experience `thresholds[i]` the EHP rate is `rates[i]`.