battlemetrics/README.md

A Promise-Based Battlemetrics API Wrapper

# Battlemetrics API Wrapper

A Promise-Based Battlemetrics API Wrapper  
Very much a work in progress project, New Versions will be released Daily so make sure to stay up to date.  

[Full docs available at https://blained-dev.github.io/bm-api/](https://blained-dev.github.io/bm-api/)

## How to use

Install it through your favorite package manager:

```bash
yarn add battlemetrics
# or
npm i battlemetrics
```

Here's a quick example of usage:

```js
const { BattlemetricsClient } = require('battlemetrics');

//Not a valid API Key
const Battlemetrics = new BattlemetricsClient({
    apiKey: 'N68Gg9uM5wvabSzV9SwFVz4fvvgnpSii25FfJqZefXXe4NYUe3Sb6',
});

Battlemetrics.getBanInfoById('15510636').then((res) => {
	console.log(res);
}).catch((err) => {
    console.log(err)
});
```