wassname/GarageServer.IO
1
0
Fork 0
mirror of https://github.com/wassname/GarageServer.IO.git synced 2026-07-03 17:10:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

Progress: Documentation

Browse Source
This commit is contained in:
Jeremiah Billmann
2013-07-29 13:09:10 -04:00
parent 2b9dd7c767
commit 7a8fb7d06b
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -3
View File
@@ -112,13 +112,13 @@ var playerStates = GarageServerIO.getPlayerStates(),
```js
GarageServerIO.initializeGarageServer(path, options)
```
Establish connection to GarageServer.IO on the server via Socket.IO and register events.
Establish connection to GarageServer.IO on the server via Socket.IO and register events.
`path`
**Type:** string
The URL that points to where GarageServer.IO is running at on the server.
The URL that points to where GarageServer.IO is running at on the server.
`options`
**Type:** object literal
Configure the different options, events, callbacks that you would like to consume on the client.
Configure the different options, events, callbacks that you would like to consume on the client.
```js
options.onPlayerConnect(callback)
```