From 01aa21324c68cc184369d8b143c9a8bbe35aa7b1 Mon Sep 17 00:00:00 2001
From: Andrew <andy@tensixtyone.com>
Date: Mon, 14 Oct 2013 01:21:42 +0100
Subject: [PATCH] Added README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7194cbc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+EVEStandings
+============
+
+A simple library / cli tool to create a standings overview page for a EVE Online corporation or alliance.
+
+Usage
+-----
+
+For CLI command use:
+
+- Install evestandings using `python setup.py install`
+- Run the `evestandings` command.
+
+For library use:
+
+- Import `Standings` from `standings`
+- Init the `Standings` object with your Key ID and vCode (needs ContactList as the only permission)
+- Call `render_template`, `text`, or `html` to produce an output.
+- Raw standings can be obtained from a dict by calling `Standings._get_standings()`
+
+About
+-----
+
+This tool was originally created by Matalok / Andrew Williams for use by Test Alliance Please Ignore.
\ No newline at end of file