Skip to content

Commit

Permalink
docs(readme): fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Kumar Harsh committed May 15, 2018
1 parent 77c8a4e commit dfcfff1
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit dfcfff1

Please sign in to comment.