From ff1fc5e3bcda1eea3cc5019cc7166458ce94d78a Mon Sep 17 00:00:00 2001 From: Till Sanders Date: Thu, 21 Mar 2024 17:17:41 +0100 Subject: [PATCH] docs: improve introduction Signed-off-by: Till Sanders --- README.md | 9 +++++---- package.json | 2 +- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a53e844..855fbe0 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/package.json b/package.json index 6e63c75..bd55705 100644 --- a/package.json +++ b/package.json @@ -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": { ".": {