Progress: Documentation

This commit is contained in:
Jeremiah Billmann
2013-07-29 15:13:43 -04:00
parent b2c4bf209b
commit 9e1ce1b702
+2 -2
View File
@@ -113,9 +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` string
`path` **string**
The URL that points to where GarageServer.IO is running at on the server.
`options` object literal
`options` **object literal**
Configure the different options, events, callbacks that you would like to consume on the client.
```js
options.onPlayerConnect(callback)