Skip to content

Commit

Permalink
Specify a minimum version of Node.js
Browse files Browse the repository at this point in the history
Makes it clear what should work and isn't expected to work
  • Loading branch information
TTTaevas committed Apr 19, 2024
1 parent 439ce5e commit 99b89ec
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 99b89ec

Please sign in to comment.