Skip to content

Commit

Permalink
Adds usage information to the README
Browse files Browse the repository at this point in the history
Having this information in the README saves users from wondering how to access the polyfill.
  • Loading branch information
adamvoss authored Jun 29, 2017
1 parent 0647c63 commit ddb4556
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,11 @@ node v8.0.0 added support for a built-in `util.promisify`: https://github.com/no

This package provides the built-in `util.promisify` in node v8.0.0 and later, and a replacement in other environments.

## Usage

```js
const promisify = require('util.promisify')
// Use `promisify` just like the built-in
```

Note: this package requires a native ES5 environment, and for `Promise` to be globally available. It will throw upon requiring it if these are not present.

0 comments on commit ddb4556

Please sign in to comment.