From f8ffad02cb2741be9761833c788d623b1112bb7f Mon Sep 17 00:00:00 2001 From: Pandipipas <62224708+Pandipipas@users.noreply.github.com> Date: Tue, 3 Mar 2026 12:26:58 +0100 Subject: [PATCH] Update docs to require Node.js 24.14.0+ --- README.md | 11 ++++++++--- package.json | 2 +- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 886f23a..0b18bc3 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,7 @@ NodeCG bundle for producing fighting game overlays. ## Requirements -- Node.js 22+ -- NodeCG 2.3+ +- Node.js 24.14.0+ ## Scripts @@ -18,9 +17,15 @@ NodeCG bundle for producing fighting game overlays. - `npm run build`: builds dashboard/graphics and extension. - `npm run lint`: validates project linting. - `npm run schema-types`: generates types from schemas. -- `npm run start`: starts NodeCG. +- `npm run start`: starts NodeCG using the local dependency (`nodecg start`). - `npm run watch`: development mode with watch. +## Usage + +- `npm install` +- `npm run build` +- `npm run start` (equivalent to `npx nodecg start`) + ## Version Initial project version: `0.1.0`. diff --git a/package.json b/package.json index 4006126..b18b26c 100644 --- a/package.json +++ b/package.json @@ -22,7 +22,7 @@ "build": "vite build && tsc -b tsconfig.extension.json", "lint": "eslint", "schema-types": "nodecg schema-types", - "start": "cd ../.. && node index.js", + "start": "nodecg start", "watch": "conc -n B,E -c red,blue -k vite \"tsc -b -w --preserveWatchOutput tsconfig.extension.json\"" }, "nodecg": {