diff options
| author | Asa Venton <asav1410@gmail.com> | 2020-10-19 13:19:07 +0100 |
|---|---|---|
| committer | Asa Venton <asav1410@gmail.com> | 2020-10-19 13:19:07 +0100 |
| commit | 792388ab9a4bf44b2705470d8825c14a81d9541d (patch) | |
| tree | 9e273ade20aa0c6c400ae2712bb944d254081d84 | |
| parent | cc9d7c85b8ea083853ce91e2cbc3f594053b1de3 (diff) | |
Add readme
| -rw-r--r-- | readme.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..6f55029 --- /dev/null +++ b/readme.md @@ -0,0 +1,29 @@ +OED Query +============== + +About +----- + +Bash script for querying various info from Oxford English Dictionary (https://www.oed.com/) + +Usage +----- + +./oedquery.sh [flag] [word] + +Flags +-d define (default) - return first definition of each lexical category with an example sentence. +-et etymology - return etymology, if available, for given word. +-a audio - return first audio file for given word. +-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 or args (once that's done). + +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 (https://developer.oxforddictionaries.com/) + +Sources +------- + +Oxford English Dictionary API - English Dictionary published by Oxford University |