Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
RoCky Wu committed May 16, 2016
1 parent 3a9ec25 commit 311d716
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,22 @@
# Stop.js
The Promise based `setTimeout` and `setImmediate` for the modern browsers and node.

## ‼️Important
`stop.js` change to use `milliseconds` as default unit. [#1](https://github.com/rwu823/stop.js/issues/1)

## Browser Supported

![](https://raw.githubusercontent.com/rwu823/stop.js/master/assets/supported-browsers.png)

## Why
In ES7 `async`/`await` is awesome, but that only supported with Promise.

## Setup
Include `babel-polyfill` before use `async` and `await`
## Installation
```js
npm i --save stop.js
```

Includes `babel-polyfill` before use `async` and `await`


## Before
Expand All @@ -37,7 +44,7 @@ asyncFunc()
```

## setImmediate
`0` is default, it will calls [`setImmediate`](https://github.com/YuzuJS/setImmediate) library
`0` is default, it will calls [`YuzuJS/setImmediate`](https://github.com/YuzuJS/setImmediate) library

```js
console.log(1)
Expand Down

0 comments on commit 311d716

Please sign in to comment.