Skip to content

Commit b526710

Browse files
Copilotalbe
andauthored
docs: add CJS/0.x fallback note to README and getting-started
Agent-Logs-Url: https://github.com/albe/node-event-storage/sessions/accacbd4-f01f-40b6-bd9b-9378af17fa42 Co-authored-by: albe <4259532+albe@users.noreply.github.com>
1 parent 1b49590 commit b526710

2 files changed

Lines changed: 11 additions & 2 deletions

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,9 @@ There is currently only a single other embedded event store for node/javascript:
3232
npm install event-storage
3333
```
3434

35-
## Quick Start
35+
> **CommonJS / `require()` users:** version 1.0 is ESM-only. If your project uses `require()` and migrating to ESM is not an option, install the 0.x series (`npm install event-storage@0`) which is functionally equivalent and retains full CJS support.
36+
37+
3638

3739
```javascript
3840
import { EventStore } from 'event-storage';

docs/getting-started.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,14 @@ Install the package from npm:
88
npm install event-storage
99
```
1010

11-
## Quick Start
11+
!!! note "CommonJS users"
12+
Version 1.0 is ESM-only (`import` syntax). If your project uses `require()` and migrating to ESM is not currently an option, the **0.x series** is functionally equivalent and retains full CJS support:
13+
14+
```bash
15+
npm install event-storage@0
16+
```
17+
18+
1219

1320
```javascript
1421
import { EventStore } from 'event-storage';

0 commit comments

Comments
 (0)