Progress: Documentation

This commit is contained in:
Jeremiah Billmann
2013-07-29 13:09:54 -04:00
parent 7a8fb7d06b
commit a84aa60299
+2 -4
View File
@@ -113,11 +113,9 @@ var playerStates = GarageServerIO.getPlayerStates(),
GarageServerIO.initializeGarageServer(path, options)
```
Establish connection to GarageServer.IO on the server via Socket.IO and register events.
`path`
**Type:** string
`path` string
The URL that points to where GarageServer.IO is running at on the server.
`options`
**Type:** object literal
`options` object literal
Configure the different options, events, callbacks that you would like to consume on the client.
```js
options.onPlayerConnect(callback)