From dfcfff154be097ee099039e292f72797760fc711 Mon Sep 17 00:00:00 2001 From: Kumar Harsh Date: Tue, 15 May 2018 17:52:45 +0530 Subject: [PATCH] docs(readme): fix readme --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bb5cc9f..d86dc07 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,25 @@ # custom-event-polyfill -Polyfill for creating CustomEvents on IE9/10/11 if native implementation is missing. +A polyfill for creating CustomEvents on IE9+ if the native implementation is missing. ## Install ``` -$ npm install custom-event-polyfill +# using yarn +$ yarn add @playlyfe/custom-event-polyfill + +# using npm +$ npm install --save @playlyfe/custom-event-polyfill ``` -## Usage +## Usage + +Just include this polyfill before using any code which creates a CustomEvent +object, ideally as early as possible. +Refer to the CustomEvent documentation for details on how to use it: https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent ## License -MIT +MIT