Skip to content

docs(readme): Node.js 18+ → 20+ to match engines pin + CI matrix#190

Merged
CryptoJones merged 1 commit into
masterfrom
docs/readme-node-version-requires-20-not-18
May 19, 2026
Merged

docs(readme): Node.js 18+ → 20+ to match engines pin + CI matrix#190
CryptoJones merged 1 commit into
masterfrom
docs/readme-node-version-requires-20-not-18

Conversation

@CryptoJones
Copy link
Copy Markdown
Owner

Closes #189.

Summary

README's Requirements line said "Node.js 18+" but engines.node is
">=20.0.0", the badge says 20+, and CI tests only 20+22. One-line
fix.

Test plan

  • npm run lint clean
  • npm test — 635 passed (docs-only change)

Proudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/

…gines pin

The Requirements section said "Node.js 18+ (tested on 20 and 22)"
but `package.json` declares `"engines": { "node": ">=20.0.0" }`,
the README badge already says "Node.js 20+", and the CI matrix
only tests Node 20 and 22. A contributor on Node 18 reading just
the Requirements line would `npm install` and get an engines-
mismatch warning that contradicts the docs.

One-line fix bringing the README in line with the engines pin
+ CI + badge. No other content change.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@CryptoJones CryptoJones merged commit 4501a40 into master May 19, 2026
3 checks passed
@CryptoJones CryptoJones deleted the docs/readme-node-version-requires-20-not-18 branch May 19, 2026 09:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(readme): Requirements says "Node.js 18+" but engines is ">=20.0.0" and CI only tests 20+22

1 participant