define

command module
v0.0.0-...-c4bc1fe Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 25, 2020 License: MIT Imports: 10 Imported by: 0

README

define Build Status Go Report Card

A cli tool for defining words, and building a local dictionary.

About

Allows you to define, store, and lookup previously defined words.

Installation

$ go get github.com/Kjoedicker/define

or

$ git clone https://github.com/Kjoedicker/define.git
$ cd define 
$ go build .

You will need to create a developer account with dictionary

This is required inorder to gain acess to an api key, which you will need to include in conf.yaml

conf.yaml

conf.yaml file is defined in the executable path

The following is to be included:

---
website: dictionary.com [0]
link: https://www.dictionaryapi.com/api/v3/references/collegiate/json/
apiKey: <insert apikey>
dictionary: dictionary.json [1]

[0] At this stage in development, there is only one api that is interfaced with.

[1] Another filename can be specified.

Use

Input

$ ./define example

Output

1 - one that serves as a pattern to be imitated or not to be imitated
2 - a punishment inflicted on someone as a warning to others; also : an individual so punished
3 - one that is representative of all of a group or type
Functionality

Undefined words are turned into an api request, which is returned, and stored in dictionary.json.

Already defined words are referenced during runtime from dictionary.json

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL