incidents/README.md

Node.js SDK for the Brandscale Incidents API, a system for reporting, monitoring, and keeping users up-to-date about server status and incidents.

# incidents [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=W8YFZ425KND68) [![NPM version](https://img.shields.io/npm/v/incidents.svg?style=flat)](https://www.npmjs.com/package/incidents) [![NPM monthly downloads](https://img.shields.io/npm/dm/incidents.svg?style=flat)](https://npmjs.org/package/incidents) [![NPM total downloads](https://img.shields.io/npm/dt/incidents.svg?style=flat)](https://npmjs.org/package/incidents)

> Node.js SDK for the Brandscale Incidents API, a system for reporting, monitoring, and keeping users up-to-date about server status and incidents.

Please consider following this project's author, [Jon Schlinkert](https://github.com/brandscale), and consider starring the project to show your :heart: and support.

## Install

Install with [npm](https://www.npmjs.com/) (requires [Node.js](https://nodejs.org/en/) >=8):

```sh
$ npm install --save incidents
```

## Usage

```js
const incidents = require('incidents');
```

## About

<details>
<summary><strong>Contributing</strong></summary>

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

</details>

<details>
<summary><strong>Running Tests</strong></summary>

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

```sh
$ npm install && npm test
```

</details>

<details>
<summary><strong>Building docs</strong></summary>

_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_

To generate the readme, run the following command:

```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```

</details>

### Author

**Jon Schlinkert**

* [GitHub Profile](https://github.com/brandscale)
* [Twitter Profile](https://twitter.com/brandscale)
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)

### License

Copyright © 2019, [Jon Schlinkert](https://github.com/brandscale).
Released under the MIT License.

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on September 08, 2019._