github.com/jakewarren/define@v1.0.1-0.20230216022724-0146b4213218/README.md (about)

     1  # define
     2  [![Build Status](https://github.com/jakewarren/define/workflows/lint/badge.svg)](https://github.com/jakewarren/define/actions)
     3  [![GitHub release](http://img.shields.io/github/release/jakewarren/define.svg?style=flat-square)](https://github.com/jakewarren/define/releases])
     4  [![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://godoc.org/github.com/jakewarren/define)
     5  [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/jakewarren/define/blob/master/LICENSE)
     6  [![Go Report Card](https://goreportcard.com/badge/github.com/jakewarren/define)](https://goreportcard.com/report/github.com/jakewarren/define)
     7  [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=shields)](http://makeapullrequest.com)
     8  
     9  > A command-line dictionary app for Oxford.
    10  
    11  This program is a hard fork of [Rican7/define](https://github.com/Rican7/define) which only provides support for the v2 Oxford API.
    12  
    13  ![](screenshot.jpg)
    14  
    15  ## Installation
    16  ### Option 1: Binary
    17  
    18  Download the latest release from [https://github.com/jakewarren/define/releases/latest](https://github.com/jakewarren/define/releases/latest)
    19  
    20  ### Option 2: From source
    21  If you have a working Go environment, you can install via `go get`:
    22  ```shell
    23  go get github.com/jakewarren/define/...
    24  ```
    25  
    26  ## Configuration
    27  
    28  Uses the configuration scheme used by [Rican7/define](https://github.com/Rican7/define).
    29  
    30  Example `~/.define.conf.json`:
    31  ```
    32  {
    33      "OxfordDictionary": {
    34          "AppID": "abc",
    35          "AppKey": "abc123"
    36      },
    37  }
    38  ```
    39  
    40  ### Configuration file
    41  
    42  A configuration file can be stored at `~/.define.conf.json` and **define** will automatically load the values specified there.
    43  
    44  ### Environment variables
    45  
    46  Some configuration values can also be specified via environment variables. This is especially useful for API keys of different sources.
    47  
    48  The following environment variables are read by **thesaurus**'s sources:
    49  
    50  - `OXFORD_DICTIONARY_APP_ID`
    51  - `OXFORD_DICTIONARY_APP_KEY`
    52  
    53  ## Acknowledgements
    54  
    55  Very heavily based on:
    56  * [travis-g/dict](https://github.com/travis-g/dict)
    57  * [Rican7/define](https://github.com/Rican7/define)
    58  
    59  
    60  ## Obtaining API keys
    61  
    62  The following are links to register for API keys for the different sources:
    63  
    64  - [Oxford Dictionaries API](https://developer.oxforddictionaries.com/?tag=#plans)