From 2b9dd7c7677c5eedea9f95fc99ba779df3dc0136 Mon Sep 17 00:00:00 2001 From: Jeremiah Billmann Date: Mon, 29 Jul 2013 13:08:29 -0400 Subject: [PATCH] Progress: Documentation --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d470a0e..b0028c5 100644 --- a/README.md +++ b/README.md @@ -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)