getstalkr/stalkr-api-js-client

<h1 align="center">
    <img src="docs/images/banner.png" alt="Stalkr Logo" width="800px">
    <br>
    <br>
</h1>

<br>
<br>

<p align="center">
  A JavaScript high level wrapper around Stalkr's API.
<br>
<br>

<a href="https://travis-ci.org/getstalkr/stalkr-api-js-client">
    <img src="https://travis-ci.org/getstalkr/stalkr-api-js-client.svg?branch=master" alt="Build Status">
</a>

<a href="https://codebeat.co/projects/github-com-getstalkr-stalkr-api-js-client-master">
  <img alt="codebeat badge" src="https://codebeat.co/badges/4ec6fc86-83e1-43e0-b581-d4ebdc358a87" />
</a>

<a href="https://codeclimate.com/github/getstalkr/stalkr-api-js-client">
    <img src="https://codeclimate.com/github/getstalkr/stalkr-api-js-client/badges/gpa.svg" />
</a>

<a href="https://david-dm.org/getstalkr/stalkr-api-js-client" title="dependencies status">
    <img src="https://david-dm.org/getstalkr/stalkr-api-js-client/status.svg"/>
</a>

<a href="https://david-dm.org/getstalkr/stalkr-api-js-client?type=dev" title="devDependencies status">
    <img src="https://david-dm.org/getstalkr/stalkr-api-js-client/dev-status.svg"/>
</a>

<a href="LICENSE.md">
    <img src="https://img.shields.io/badge/license-MIT-brightgreen.svg" alt="MIT License">
</a>

</p>
<br>

---

## Table of Contents

<!-- DO NOT EDIT THE COMMENTS BELOW -->

<!-- toc -->

- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)

<!-- tocstop -->

## Installation

```sh
# Install via yarn
yarn add stalkr-api-js-client

# or npm
npm install stalkr-api-js-client
```

## Usage

```js
// Use our default export:
import StalkrClient from 'stalkr-api-js-client';

// Or just the parts you need:
import {Users} from 'stalkr-api-js-client';
```

## Contributing

We are open to contributions, see [CONTRIBUTING.md](CONTRIBUTING.md) for more info.

---

**Maintainers**:

> [ythecombinator.me](https://ythecombinator.me) &nbsp;&middot;&nbsp;
> GitHub [@ythecombinator](https://github.com/ythecombinator) &nbsp;&middot;&nbsp;
> Twitter [@ythecombinator](https://twitter.com/ythecombinator)

> [cardo.so](http://cardo.so) &nbsp;&middot;&nbsp;
> GitHub [@cardoso](https://github.com/cardoso)