From 985d6b653865eb9ae2b03bcba6d409cd8685d9c3 Mon Sep 17 00:00:00 2001 From: Priyajeet Hora Date: Tue, 16 Jan 2018 13:20:26 -0800 Subject: [PATCH] Update: Add documentation for regenerator runtime --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index da4b2ec47a..64ea45b009 100644 --- a/README.md +++ b/README.md @@ -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)