node-epicsgg/README.md

An interface to communicate with Epics.gg API

<h1 align="center">Welcome to node-epicsgg 👋</h1>
<p>
  <img alt="Version" src="https://img.shields.io/npm/v/node-epicsgg.svg">
  <img src="https://img.shields.io/badge/node-%3E%3D8.0.0-blue.svg" />
  <a href="https://roguyt.github.io/node-epicsgg/">
    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" target="_blank" />
  </a>
  <a href="https://github.com/Roguyt/node-epicsgg/graphs/commit-activity">
    <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" target="_blank" />
  </a>
  <a href="https://github.com/Roguyt/node-epicsgg/blob/master/LICENSE">
    <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" target="_blank" />
  </a>
  <a href="https://twitter.com/ClmntW">
    <img alt="Twitter: ClmntW" src="https://img.shields.io/twitter/follow/ClmntW.svg?style=social" target="_blank" />
  </a>
</p>

> An interface to communicate with Epics.gg API

### 🏠 [Homepage](https://github.com/Roguyt/node-epicsgg#readme)

### 📝 [Documentation](https://roguyt.github.io/node-epicsgg/)

## Prerequisites

-   node >=8.0.0

## Install

```sh
npm install node-epicsgg
```

## Usage

```js
const epicsgg = require('node-epicsgg');
const epics = new epicsgg({ email: 'example@example.com', password: 'example123' });
```

## Run tests

```sh
npm run test
```

## Author

👤 **Roguyt**

-   Twitter: [@ClmntW](https://twitter.com/ClmntW)
-   Github: [@Roguyt](https://github.com/Roguyt)

## Contributors

-   **SherloxTV** ([Github](https://github.com/SherloxTV), [Twitch](https://twitch.tv/SherloxTV), [Twitter](https://twitter.com/SherloxTV))

## 🤝 Contributing

Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/Roguyt/node-epicsgg/issues).

## Show your support

Give a ⭐️ if this project helped you!

## 📝 License

Copyright © 2019 [Roguyt](https://github.com/Roguyt).<br />
This project is [MIT](https://github.com/Roguyt/node-epicsgg/blob/master/LICENSE) licensed.

---

_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_