Skip to content
This repository has been archived by the owner on Dec 25, 2021. It is now read-only.

Commit

Permalink
fix(readme): installation and support description
Browse files Browse the repository at this point in the history
this and previous issues fix #1 and #2
  • Loading branch information
alivenotions committed Nov 17, 2018
1 parent 9e21fb9 commit c999d4f
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,25 @@

A pull-based polling utility that allows you to poll any function that returns a promise with configurable delay.

## Getting started

Install using npm:

```
npm install @alivenotions/simple-poll
```

With a script tag:

```html
<script src="https://unpkg.com/@alivenotions/[email protected]/dist/poll.umd.min.js"></script>
```

## Support

* Works for Node >= 6
* Works on all modern browsers. (TODO: the exact versions and for IE)

## Create a polling object

The Poll function expects an object with three keys:
Expand Down

0 comments on commit c999d4f

Please sign in to comment.