From 7a1b0231d046a61cbcb2d643be99f771ae6604f5 Mon Sep 17 00:00:00 2001
From: Michael Morrison <mmorrison@wootalyzer.com>
Date: Fri, 12 Jul 2013 04:18:55 -0500
Subject: [PATCH] Readme formatting

---
 README.md | 50 +++++++++++++++++++++++++-------------------------
 1 file changed, 25 insertions(+), 25 deletions(-)

diff --git a/README.md b/README.md
index 711260f..dd133c5 100644
--- a/README.md
+++ b/README.md
@@ -22,16 +22,16 @@ Gamedig.query(
 );
 ```
 
-Input Parameters
----
-* type (one of the types from the protocols folder)
-* host
-* port (uses the protocol default if not set)
-* login (required by nadeo protocol)
-* password (required by nadeo protocol)
+### Input Parameters
+
+* **type**: One of the types from the protocols folder
+* **host**
+* **port**: Uses the protocol default if not set
+* **login**: Required by nadeo protocol
+* **password**: Required by nadeo protocol
+
+###Callback Function
 
-Callback Function
----
 The callback function is "guaranteed" to be called exactly once.
 
 If an error occurs, the returned object will contain an "error" key, indicating the issue.
@@ -39,20 +39,20 @@ If the error key exists, it should be assumed that the game server is offline or
 
 Otherwise, the returned object is guaranteed to contain the following keys:
 
-* name
-* map
-* password (boolean)
-* maxplayers
-* players (may contain name, ping, score, team, address)
-* bots (same as players)
-* raw (contains special keys depending on the type of server queried - UNSTABLE)
-* notes (passed through from the input)
-* query (details about the query performed)
- * host
- * address
- * port
- * type
- * pretty (a "pretty" string describing the game)
+* **name**
+* **map**
+* **password**: Boolean
+* **maxplayers**
+* **players**: Array of objects, each may contain name, ping, score, team, address
+* **bots**: Same as players
+* **raw**: Contains special keys depending on the type of server queried - UNSTABLE
+* **notes**: Passed through from the input
+* **query**: Details about the query performed
+ * **host**
+ * **address**
+ * **port**
+ * **type**
+ * **pretty**: A "pretty" string describing the game
 
 It can usually be assumed that the number of players online is equal to the length of the players array.
 Some servers may return an additional player count number, which may be present in the unstable raw object.
@@ -67,7 +67,7 @@ Supported Games
  * Half Life: Death Match
  * Ricochet
  * Counter-Strike: 1.6
- * + others
+ * \+ others
 * Nadeo Protocol
  * Trackmania Forever
  * Trackmania 2
@@ -82,7 +82,7 @@ Supported Games
  * Counter-Strike: Source
  * Counter-Strike: Global Offensive
  * Team Fortress 2
- * + others
+ * \+ others
 * Tshock Protocol
  * Terraria
 * Unreal 2 Protocol