readme

1 files changed, 15 insertions, 0 deletions

diff --git a/readme.txt b/readme.txt
new file mode 100644
index 0000000..221d552
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,15 @@
+thin wrapper around webster's unabridged dictionary, works offline.
+
+build:
+
+    nix build .#
+
+
+run:
+
+    /path/to/dict <word>
+
+example:
+
+    dict urbanize
+    URBANIZE To render urban, or urbane; to refine; to polish. Howell.