Skip to content

Commit d117db5

Browse files
committed
Cleanup README
1 parent 0239059 commit d117db5

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,13 @@
22

33
## v6.0.0 (2025-11-02)
44

5+
**❗️ Breaking Changes**
6+
57
- Dropped support for CJS modules. This package is now ESM-only.
8+
- Changed the internal directory structure under `lib`. If you are importing from a specific file, you need to change the path.
9+
10+
**Other Changes**
11+
612
- Migrated the test framework from Jest to Node's Test Runner.
713
- Set the tests to run only on Node 20, 22, and 24. However, this package is expected to function in any JS environment as long as ESM is supported; if it does not, please file an issue.
814

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,11 @@ The range data are always _sorted and normalized_ to the smallest possible repre
2121

2222
---
2323

24-
🚨 **Note**: The following README is for the 5.x release, whose API has changed drastically. For the docs of the 4.x release, see [this](https://github.com/smikitky/node-multi-integer-range/tree/v4.0.9).
24+
🚨 **Note**: The following README is for the 6.x/5.x releases, whose API has changed drastically. For the docs of the 4.x release, see [this](https://github.com/smikitky/node-multi-integer-range/tree/v4.0.9).
2525

2626
## Install
2727

28-
Install via npm or yarn:
29-
30-
```
31-
npm install multi-integer-range
32-
```
28+
Install using any package manager or ESM-ready CDN.
3329

3430
Version 6 is a fully tree-shakable, ESM-only package. This package has no external dependencies nor does it use any Node-specific API.
3531

@@ -198,7 +194,7 @@ npm ci
198194
npm test
199195
```
200196

201-
To generate CJS and ESM builds:
197+
To build:
202198

203199
```
204200
npm ci

0 commit comments

Comments
 (0)