diff --git a/examples/furioos-sdk-js-example/README.md b/examples/furioos-sdk-js-example/README.md index 12de978..0f56c51 100644 --- a/examples/furioos-sdk-js-example/README.md +++ b/examples/furioos-sdk-js-example/README.md @@ -3,23 +3,33 @@ This project is a simple nodeJS server that render a single HTML page. It is a first step to try Furioos SDK with your links on Furioos. It also a way to debug localy your application. -## Installation -You just need to **download** the full project zipped. +# Requirements +[node.js](http://nodejs.org/) -- v12.x or newer -**Unzip** it where you want. +# Installation +```bash +npm install +``` +or +```bash +yarn +``` -**Go under** `examples/furioos-sdk-js-example` (this subfolder should be extracted from the whole project to make your test). -:warning: Keeping and running the example folder form the furioos-sdk-js folder could trigger errors. +# Run -**Run it** -Execute npm install -then npm start +```bash +npm run start +``` +or +```bash +yarn start +``` Here you get two things running : 1. A nodeJS server running on port 8080: To test a full JS integration of Furioos' SDK 2. A Websocket server running on port 8081: To communicate localy with your application using the [Furioos Unity SDK](https://github.com/Unity-Technologies/furioos-sdk-unity) -## How does the websocket server work ? +# How does the websocket server work ? The Websocket server running on port 8081 is here to allow connection between this JS project running localy (or your own JS project running localy) and your application running locally too. Both are connecting to the server to communicate.