From 46c3daa6d5e11cfbee562dc943dfa092b4c2211e Mon Sep 17 00:00:00 2001
From: ozzy <ozzyspam@proton.me>
Date: Sun, 30 Aug 2026 16:12:34 -0500
Subject: [PATCH] chore(project): add readme

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a56b309
--- /dev/null
+++ b/README.md
@@ -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`.