From 45cb961a899c28ae0c4fbd336387d85918d2bb75 Mon Sep 17 00:00:00 2001
From: Nathan Adams <dinnerbone@dinnerbone.com>
Date: Sun, 6 Nov 2011 07:21:36 +0000
Subject: [PATCH] Added readme

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..af84b02
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+MinecraftQuery
+======
+
+With 1.9 came a shiny new tool to allow native status querying in vanilla Minecraft servers.
+This is a simple class designed to aid in retrieving any data from the servers.
+
+See it in action: [http://dinnerbone.com/minecraft/tools/status/](http://dinnerbone.com/minecraft/tools/status/)
+Protocol documention: [http://dinnerbone.com/blog/2011/10/14/minecraft-19-has-rcon-and-query/](http://dinnerbone.com/blog/2011/10/14/minecraft-19-has-rcon-and-query/)
+
+Usage
+-----------
+
+    from status_query import MinecraftQuery
+    
+    query = MinecraftQuery("localhost", 25565)
+    
+    basic_status = query.get_status()
+    print "The server has %d players" % (basic_status['numplayers'])
+    
+    full_info = query.get_rules()
+    print "The server is on the map '%s'" % (full_info['map'])
+
+Rights
+-----------
+Fully open. Go wild.
\ No newline at end of file