Progress: Documentation

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