From 8443534d2b6f14f58717b4810f952fafaadaf239 Mon Sep 17 00:00:00 2001 From: Daniel Dewhurst Date: Thu, 2 Dec 2021 21:46:00 +0000 Subject: [PATCH] Update README.md --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 405d8ec..376733d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # samp-node -a SA-MP plugin to support nodejs apps and run them on your server +samp-node is a SA-MP plugin that allows you to run Node.js, meaning you can code in JS/TS instead of pawn. --------- @@ -12,10 +12,19 @@ You can always find latest builds [here](https://github.com/AmyrAhmady/samp-node But if you are looking for a stable version (or using sampctl), please visit [here](https://github.com/AmyrAhmady/samp-node/wiki/Installation) -## type definitions for TypeScript -here's a link to the repository: https://github.com/samp-dev/node \ -follow the instructions there to make best use of it\ -special thanks to [pkfln (peek)](https://github.com/pkfln). +## Node version +Currently samp-node uses Node.js v16. + + +## Tips +You should transpile your JS into commonjs to avoid issues. \ +It's recommended you use TypeScript and setup a tsconfig that extends [@tsconfig/node16](https://www.npmjs.com/package/@tsconfig/node16). + + +## Type definitions for TypeScript +If you're using TypeScript then take a look at this repoistory: https://github.com/samp-dev/node \ +Instructions can be found there on how to install and use them. \ +*Special thanks to [pkfln (peek)](https://github.com/pkfln).* ## Credits