From 1463cacfa6a895d3d774ffeb3d27aa5cf0344c4a Mon Sep 17 00:00:00 2001
From: jbillmann <jcbillmann@yahoo.com>
Date: Mon, 22 Jul 2013 17:51:44 -0500
Subject: [PATCH 1/4] Update README.md

---
 README.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/README.md b/README.md
index 75c1e7d..ef4600f 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,42 @@ A simple, lightweight, HTML multiplayer game server (and client) for Node.js
 
 ### Client
 
+```js
+GarageServerIO.initializeGarageServer(path, options)
+
+options = {
+    onPlayerConnect(callback),
+    onPlayerDisconnect(callback),
+    onPlayerReconnect(callback),
+    onPlayerUpdate(callback(state)),
+    onEntityUpdate(callback(state)),
+    onPlayerRemove(callback(id)),
+    onEntityRemove(callback(id)),
+    onEvent(callback(data)),
+    onWorldState(callback(state)),
+    onPing(callback(pingDelay)),
+    onUpdatePlayerPhysics(callback(state, inputs, deltaTime)),
+    onInterpolation(callback(previousState, targetState, amount)),
+    onReady(callback,
+    logging: true
+}
+```
+
+```js
+GarageServerIO.addInput(input)
+```
+
+```js
+GarageServerIO.getStates(callback(playerStates: [player1State, player2State, ...], entityStates: [entity1State, entity2State, ...]))
+```
+
+```js
+GarageServerIO.getId() : 'playerid'
+```
+
+```js
+GarageServerIO.sendServerEvent(data)
+```
 
 ### Server
 

From 9235217ac15dd2c3cb8e96725f27340655d67444 Mon Sep 17 00:00:00 2001
From: jbillmann <jcbillmann@yahoo.com>
Date: Mon, 22 Jul 2013 18:24:46 -0500
Subject: [PATCH 2/4] Update README.md

---
 README.md | 45 ++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 44 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index ef4600f..b0f7a57 100644
--- a/README.md
+++ b/README.md
@@ -47,7 +47,7 @@ GarageServerIO.addInput(input)
 ```
 
 ```js
-GarageServerIO.getStates(callback(playerStates: [player1State, player2State, ...], entityStates: [entity1State, entity2State, ...]))
+GarageServerIO.getStates(callback([player1State, player2State, ...], [entity1State, entity2State, ...]))
 ```
 
 ```js
@@ -60,6 +60,49 @@ GarageServerIO.sendServerEvent(data)
 
 ### Server
 
+```js
+createGarageServer(io, options)
+```
+
+```js
+start()
+```
+
+```js
+stop()
+```
+
+```js
+getPlayers() : [{ id, state, [input1, input2,...], [{ state1, executionTime1 }, { state2, executionTime2 }, ...] }]
+```
+
+```js
+getEntities() : [{ id, state, [{ state1, executionTime1 }, { state2, executionTime2 }, ...] }]
+```
+
+```js
+updatePlayerState(id, state)
+```
+
+```js
+updateEntityState(id, state)
+```
+
+```js
+addEntity(id)
+```
+
+```js
+removeEntity(id)
+```
+
+```js
+sendPlayerEvent(id, data)
+```
+
+```js
+sendPlayersEvent(data)
+```
 
 ## Resources
 

From 2c25a74af88663259befd8e6da41edb494643d3d Mon Sep 17 00:00:00 2001
From: jbillmann <jcbillmann@yahoo.com>
Date: Mon, 22 Jul 2013 18:29:22 -0500
Subject: [PATCH 3/4] Update README.md

---
 README.md | 42 ++++++++++++++++++++++++++++++------------
 1 file changed, 30 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index b0f7a57..0eab0c9 100644
--- a/README.md
+++ b/README.md
@@ -51,7 +51,7 @@ GarageServerIO.getStates(callback([player1State, player2State, ...], [entity1Sta
 ```
 
 ```js
-GarageServerIO.getId() : 'playerid'
+GarageServerIO.getId() : playerid
 ```
 
 ```js
@@ -61,47 +61,65 @@ GarageServerIO.sendServerEvent(data)
 ### Server
 
 ```js
-createGarageServer(io, options)
+require('.garageserver.io').createGarageServer(io, options) : GarageServerIO
+
+options = {
+    stateInterval: 45,
+    logging: true,
+    clientSidePrediction: true,
+    interpolation: true,
+    interpolationDelay: 100,
+    smoothingFactor: 0.3,
+    pingInterval: 2000,
+    maxUpdateBuffer: 120,
+    maxHistorySecondBuffer: 1000,
+    worldState: {},
+    onPlayerConnect: function (socket),
+    onPlayerInput: function (socket, input),
+    onPlayerDisconnect: function (socket),
+    onPing: function (socket, data),
+    onEvent: function (data)
+}
 ```
 
 ```js
-start()
+GarageServerIO.start()
 ```
 
 ```js
-stop()
+GarageServerIO.stop()
 ```
 
 ```js
-getPlayers() : [{ id, state, [input1, input2,...], [{ state1, executionTime1 }, { state2, executionTime2 }, ...] }]
+GarageServerIO.getPlayers() : [{ id, state, [input1, input2,...], [{ state1, executionTime1 }, { state2, executionTime2 }, ...] }]
 ```
 
 ```js
-getEntities() : [{ id, state, [{ state1, executionTime1 }, { state2, executionTime2 }, ...] }]
+GarageServerIO.getEntities() : [{ id, state, [{ state1, executionTime1 }, { state2, executionTime2 }, ...] }]
 ```
 
 ```js
-updatePlayerState(id, state)
+GarageServerIO.updatePlayerState(id, state)
 ```
 
 ```js
-updateEntityState(id, state)
+GarageServerIO.updateEntityState(id, state)
 ```
 
 ```js
-addEntity(id)
+GarageServerIO.addEntity(id)
 ```
 
 ```js
-removeEntity(id)
+GarageServerIO.removeEntity(id)
 ```
 
 ```js
-sendPlayerEvent(id, data)
+GarageServerIO.sendPlayerEvent(id, data)
 ```
 
 ```js
-sendPlayersEvent(data)
+GarageServerIO.sendPlayersEvent(data)
 ```
 
 ## Resources

From 6a3939d336ee1c7495b4c1de47c8ec20172fd930 Mon Sep 17 00:00:00 2001
From: jbillmann <jcbillmann@yahoo.com>
Date: Mon, 22 Jul 2013 19:00:42 -0500
Subject: [PATCH 4/4] Update README.md

---
 README.md | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 0eab0c9..d6e311e 100644
--- a/README.md
+++ b/README.md
@@ -74,11 +74,11 @@ options = {
     maxUpdateBuffer: 120,
     maxHistorySecondBuffer: 1000,
     worldState: {},
-    onPlayerConnect: function (socket),
-    onPlayerInput: function (socket, input),
-    onPlayerDisconnect: function (socket),
-    onPing: function (socket, data),
-    onEvent: function (data)
+    onPlayerConnect(callback(socket)),
+    onPlayerInput(callback(socket, input)),
+    onPlayerDisconnect(callback(socket)),
+    onPing(callback(socket, data)),
+    onEvent(callback(data))
 }
 ```