summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAsa Venton <asav1410@gmail.com>2020-10-19 13:52:56 +0100
committerAsa Venton <asav1410@gmail.com>2020-10-19 13:52:56 +0100
commit5a23662fdf646506f4b68d68efe0f7ac8c14db5c (patch)
tree23e921f4c0f1c48d8db983ce20d7447a083de45d
parent792388ab9a4bf44b2705470d8825c14a81d9541d (diff)
Tidy up readme
-rw-r--r--readme.md17
1 files changed, 8 insertions, 9 deletions
diff --git a/readme.md b/readme.md
index 6f55029..433d1ba 100644
--- a/readme.md
+++ b/readme.md
@@ -12,18 +12,17 @@ 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.
+-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).
+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 (https://developer.oxforddictionaries.com/)
+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
-------
-Oxford English Dictionary API - English Dictionary published by Oxford University
+Oxford English Dictionary API (https://developer.oxforddictionaries.com/)