From 586b40fb1a56c7b484d623b55b7adceb8322a836 Mon Sep 17 00:00:00 2001 From: Jeremiah Billmann Date: Mon, 29 Jul 2013 13:06:27 -0400 Subject: [PATCH] Progress: Documentation --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index df5ded2..d470a0e 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ A simple, lightweight, HTML multiplayer game server (and client) for Node.js ## Quick Start -Create a quick game whereby players simply move squares along the x-axis. (I know, it's boring, but it keeps things simple.) For a more thorough demonstration of how GarageServer.IO works, look at the example included in the source code. +Create a quick game whereby players simply move squares along the x-axis. I know, it's boring, but it keeps things simple and to the point. For a more thorough demonstration of how GarageServer.IO works, look at the example included in the source code. ### Server @@ -113,8 +113,10 @@ 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 +```js +path +``` +**Type:** string The URL that points to where GarageServer.IO is running at on the server. **options** Type: object literal