Skip to content

Docs: require Node.js 20+ (was 18+) - #24

Merged
AshishB2000 merged 1 commit into
mainfrom
fix/readme-node-version
Jul 15, 2026
Merged

AshishB2000 merged 1 commit into
mainfrom
fix/readme-node-version

Conversation

@AshishB2000

Copy link
Copy Markdown
Owner

Fixes an inaccurate Node version requirement in the docs.

What the repo actually specifies

  • No .node-version / .nvmrc, and no package.json engines field — nothing declares a minimum.
  • The real floor comes from tooling: all 4 CI workflows use Node 20, and cross-env (devDependency) requires node >=20 (so Node 18 can't even install devDeps). electron declares node >= 22.12.0 (advisory; CI builds on 20).

So Node 20 is the practical minimum; "18+" was wrong.

Changes

  • README.md — Requirements: Node.js 18+ → Node.js 20+
  • QUICKSTART.md — same line had the identical wrong claim, bumped to 20+ for consistency

No em-dashes touched.

Node 18 can't install the current devDependencies (cross-env requires
node >=20) and CI runs on Node 20, so "18+" was inaccurate. Update the
Node requirement in README.md and QUICKSTART.md to 20+. No .node-version
or package.json engines field exists to pin it; the floor comes from CI
and cross-env.
@AshishB2000
AshishB2000 merged commit cb7eaaa into main Jul 15, 2026
2 checks passed
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.

1 participant