summaryrefslogtreecommitdiff
path: root/readme.md
blob: 038f4b5d36016462212ebb3d06747fa17ba6e8c5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
OED Query
==============

About
-----

Bash script for querying various info from Oxford English Dictionary (https://www.oed.com/)

Configuration
-----

The provided oedquery.conf.example contains all config options, all of which are required. Your config file must be named oedquery.conf and live in the same directory as the script.

Usage
-----

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.  
-a	audio - return first audio file for given word.  
-t	thesaurus - return synonyms for given word.  
-wod	word of the day - return definition for Lexico's word of the day.  

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 (https://developer.oxforddictionaries.com/)