Added readme

1 files changed, 21 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f5c84f6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+bladictionary2
+==============
+
+Python script for finding dictionary definitions.
+
+Dictionary definitions are provided by http://services.aonaware.com/
+
+This script designed to be used in IRC with a specific bot, but should 
+work fine from the command line using stdin or args (once that's done).
+
+This is a rewrite of the original bladictionary, which was written in 
+Java 4 years ago, quite badly.
+
+The purpose of the rewrite is to learn Python, clean up some long 
+standing bugs with the old version, and add some more advanced options.
+
+Libraries
+=========
+
+requests
+lxml