summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoe Robinson <joe@lc8n.com>2014-09-15 23:32:52 +0100
committerJoe Robinson <joe@lc8n.com>2014-09-15 23:32:52 +0100
commitd0e39099b8d287e9a2c070717dbba81c296442ac (patch)
treea3d54e0a194c7e245eebdd39a075c0228d61d2ca /README.md
parent42089fdbfd1fbc094581529cc1426213ed6f792e (diff)
Modified readme formating
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 11 insertions, 4 deletions
diff --git a/README.md b/README.md
index fca35fd..d07ec3d 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,28 @@
bladictionary2
==============
+About
+-----
+
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.
+Usage
+-----
+
+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).
+
+
Libraries
-=========
+---------
requests