Skip to content

Commit

Permalink
docs: improve introduction
Browse files Browse the repository at this point in the history
Signed-off-by: Till Sanders <[email protected]>
  • Loading branch information
tillsanders committed Mar 21, 2024
1 parent 67ab860 commit ff1fc5e
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# ESMitter

ESMitter is an event emitter compatible with Node.js and browsers. It is a fork of
[EventEmitter3](https://github.com/primus/eventemitter3), but natively TypeScript, ESM-only and with
more modern tooling. ESMitter is currently in alpha stage. The complete codebase has been converted
to TypeScript and ESM. ESMitter is currently less performant than EventEmitter3, but still fast.
ESMitter *(read: E-S-Emitter; a pun on ESM + emitter)* is an event emitter compatible with Node.js
and modern browsers. It is a fork of [EventEmitter3](https://github.com/primus/eventemitter3), but
natively TypeScript, ESM-only and with more modern tooling. ESMitter is currently in alpha stage.
The complete codebase has been converted to TypeScript and EcmaScript module syntax (ESM). ESMitter
is currently less performant than EventEmitter3, but still fast.

[![Version npm](https://img.shields.io/npm/v/esm-itter.svg)](https://www.npmjs.com/package/esm-itter)[![CI](https://img.shields.io/github/actions/workflow/status/tillsanders/esm-itter/ci.yml?branch=main&label=CI)](https://github.com/tillsanders/esm-itter/actions?query=workflow%3ACI+branch%3Amain)[![Coverage Status](https://img.shields.io/coveralls/tillsanders/esm-itter/main.svg)](https://coveralls.io/r/tillsanders/esm-itter?branch=main)

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "esm-itter",
"version": "0.2.0",
"description": "ESMitter is an event emitter compatible with Node.js and browsers. It is a fork of EventEmitter3, but natively TypeScript, ESM-only and with more modern tooling.",
"description": "ESMitter is an event emitter compatible with Node.js and modern browsers. It is a fork of EventEmitter3, but natively TypeScript, ESM-only and with more modern tooling.",
"type": "module",
"exports": {
".": {
Expand Down

0 comments on commit ff1fc5e

Please sign in to comment.