summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoe Robinson <joe@mumsnet.com>2014-09-18 16:03:12 +0100
committerJoe Robinson <joe@mumsnet.com>2014-09-18 16:03:12 +0100
commite9f42da5fc980b302946aad6686017f3cc91b695 (patch)
tree7a510573656c7865cb48c90b7caa51803de8c4d3 /README.md
parent193f2f9f0bf92f6fcfbceb71d0bd823bdd51f823 (diff)
Updated readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index d07ec3d..97529ee 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,13 @@ standing bugs with the old version, and add some more advanced options.
Usage
-----
+./bladictionary.py [word] [type] [dictionary]
+
+Type is the word type, eg noun, verb, adjective, adverb. If none is
+specified, all will be printed
+Dictionaries available at the moment are wn (WordNet) and oed (Oxford
+English Dictionary). Default is wn.
+
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).