chore(project): add readme
This commit is contained in:
@@ -0,0 +1,33 @@
|
|||||||
|
# define
|
||||||
|
a small, simple tool to define words from the terminal.
|
||||||
|
|
||||||
|
definitions are from the [free dictionary api](https://freedictionaryapi.com/).
|
||||||
|
|
||||||
|
## usage
|
||||||
|
|
||||||
|
```
|
||||||
|
Usage: define [OPTIONS] <WORD>
|
||||||
|
|
||||||
|
Arguments:
|
||||||
|
<WORD> word to define
|
||||||
|
|
||||||
|
Options:
|
||||||
|
-l, --language <LANGUAGE>
|
||||||
|
language of the word [default: en]
|
||||||
|
-p, --parts-of-speech <PARTS_OF_SPEECH>
|
||||||
|
parts of speech to show [default: noun verb adjective adverb pronoun preposition conjunction interjection exclamation determiner article]
|
||||||
|
-e, --examples
|
||||||
|
show examples for definitions
|
||||||
|
-h, --help
|
||||||
|
Print help
|
||||||
|
-V, --version
|
||||||
|
Print version
|
||||||
|
```
|
||||||
|
|
||||||
|
## installation
|
||||||
|
|
||||||
|
there is currently no automated installation. simply build the program and place the resulting executable in your path.
|
||||||
|
|
||||||
|
## building
|
||||||
|
|
||||||
|
build using `just`. see available recipes by running `just` or `just --list`.
|
||||||
Reference in New Issue
Block a user