From 80c5b28d85a4b2a21103c7cc4bd4ba64e658d3a3 Mon Sep 17 00:00:00 2001 From: Jeremiah Billmann Date: Sun, 18 Aug 2013 15:28:21 -0400 Subject: [PATCH] Updated example docs --- example/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/example/README.md b/example/README.md index 609b875..97f2911 100644 --- a/example/README.md +++ b/example/README.md @@ -6,4 +6,6 @@ A sample application using GarageServer.IO Change the `path` parameter of `GarageServerIO.initializeGarageServer` that is found in file, `/public/javascripts/game.js`, to point to the URL where your Node app runs. I.e. `http://127.0.0.1:3000`. Note that the example app uses a default port of `process.env.PORT || 3000`. This can be changed in `app.js`. -Execute `$ npm install` in the `example/` root directory and `$ node app.js` to run the application. \ No newline at end of file +Execute `$ npm install` in the `example/` root directory and `$ node app.js` to run the application. + +NOTE: The example has `clientSidePrediction` and `interpolation` enabled. If you're running it locally (no ping), you may want to disable these (`false`). \ No newline at end of file