From 99b89ecc9b57ea045b7fa510a369acfacb76d5d7 Mon Sep 17 00:00:00 2001 From: Taevas <67872932+TTTaevas@users.noreply.github.com> Date: Fri, 19 Apr 2024 16:39:07 +0200 Subject: [PATCH] Specify a minimum version of Node.js Makes it clear what should work and isn't expected to work --- README.md | 8 +++++++- package.json | 3 +++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d6b6088..d32a88c 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,13 @@ You can find this package's documentation on [osu-v2.taevas.xyz](https://osu-v2. ## How to install and get started -To install the package, use a command from your package manager: +Before installing, if using Node.js, check if you're running version 16 or above: + +```bash +node -v # displays your version of node.js +``` + +Then to install the package, use a command from your package manager: ```bash npm i osu-api-v2-js # if using npm diff --git a/package.json b/package.json index 6369fbb..0b94efe 100644 --- a/package.json +++ b/package.json @@ -12,6 +12,9 @@ "test-authorized": "yarn run build && node ./dist/tests/test_authorized.js", "doc": "npx typedoc lib/index.ts --cname osu-v2.taevas.xyz" }, + "engines": { + "node": ">=16.0.0" + }, "author": "Taevas", "repository": { "type": "git",