Skip to content

Commit

Permalink
Update: Add documentation for regenerator runtime
Browse files Browse the repository at this point in the history
  • Loading branch information
priyajeet authored Jan 16, 2018
1 parent dba942f commit 985d6b6
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ The instructions below describe how to use the UI Elements in a [React](https://

To prevent duplication, the UI Elements require certain peer dependencies to be installed manually. For a list of required peer dependencies, see [package.json](package.json).

This project also requires [regenerator-runtime](https://www.npmjs.com/package/regenerator-runtime), since our source code uses async/await. This can be achieved by installing the dependency (also listed as part of the peer dependencies) and then adding the following line in your parent React project:

`import 'regenerator-runtime/runtime';`

## Browser Support
* Desktop Chrome, Firefox, Safari, Edge (latest 2 versions)
* Limited support for Internet Explorer 11 (requires ES2015 polyfill)
Expand Down

0 comments on commit 985d6b6

Please sign in to comment.