summaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorAsa Venton <asav1410@gmail.com>2020-10-19 17:36:17 +0100
committerAsa Venton <asav1410@gmail.com>2020-10-19 17:36:17 +0100
commitef541f971162e798103db13059bd1e3b3898e7da (patch)
tree849059717ed4a9446c3bf33ec026821a98557ff8 /readme.md
parente55219115930fc4c0505cef6a5f876a402562ed3 (diff)
Fix errors in readme.
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/readme.md b/readme.md
index 6aac8e7..637d1fd 100644
--- a/readme.md
+++ b/readme.md
@@ -9,7 +9,14 @@ Bash script for querying various info from Oxford English Dictionary (https://ww
Usage
-----
-./oedquery.sh [flag] [word]
+This script designed to be used in IRC with a specific bot, and only works from a shell using bash read.
+
+Shell:
+./oedquery.sh
+[flag] [word] (upon bash read)
+
+Or with the bot it was designed for:
+!oed [flag] [word]
-d define (default) - return first definition of each lexical category with an example sentence.
-et etymology - return etymology, if available, for given word.
@@ -17,8 +24,6 @@ Usage
-t thesaurus - return synonyms for given word.
-wod word of the day - return defintion for Lexico's word of the day.
-This script designed to be used in IRC with a specific bot, but should work fine from the command line using stdin.
-
Note: you must provide your own App ID and App Key for access to the OED API. These can be got for free from their website.
Sources