search

miroslavpejic85 / mirotalkwebrtc

🛠 MiroTalk's WebRTC rooms scheduler.
https://webrtc.mirotalk.com
GNU Affero General Public License v3.0
264 stars 50 forks source link

Update README.md #10

Closed VishalSharma2000 closed 8 months ago

VishalSharma2000 commented 8 months ago

Update Readme file to add description about which node version to use before running npm install.

VishalSharma2000 commented 8 months ago

During local setup I mistakenly ran npm install before changing the version of node. The default version of node was not v18.

I ran into some warnings, stating Unsupported engines.

So, thought of specifying it explicitly so that other people change the node version before downloading the dependencies.

Please let me know your views and any changes required in the added documentation.

miroslavpejic85 commented 8 months ago

LGTM,

Can you please change the comment in

The project was tested with node version 18.16.0 ...

Thank you.

VishalSharma2000 commented 8 months ago

Sorry @miroslavpejic85, didn't got you.

Are you asking me to update the The project requires node version = 18.16.0 in the added line to update to The project was tested with node version 18.16.0?

miroslavpejic85 commented 8 months ago

Exactly! The other part of the comment is ok ;)

# The project was tested with node version 18.16.0. So make sure to update the node version using nvm if you have multiple version installed.
# After updating the node version, you can verify using
$ node --version # v18.16.0
...
VishalSharma2000 commented 8 months ago

Updated.

Please let me know if you feel any more changes can be made :)