Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
goto-bus-stop committed May 18, 2018
1 parent 4121c64 commit c40bd27
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions Readme.md
Expand Up @@ -4,18 +4,24 @@

Node's event emitter for all engines.

## Install ##
## Install

```
npm install events
```

## Require ##
## Usage

```javascript
var EventEmitter = require('events')
```

## Usage ##
Note that the `events` module uses ES5 features. If you need to support very old browsers like IE8, use a shim like [`es5-shim`](https://www.npmjs.com/package/es5-shim). You need both the shim and the sham versions of `es5-shim`.

See the [node.js event emitter docs](http://nodejs.org/api/events.html)
## API

See the [Node.js EventEmitter docs](http://nodejs.org/api/events.html). `events` currently matches the Node.js 10.1 API.

## License

[MIT](./LICENSE)

0 comments on commit c40bd27

Please sign in to comment.