Initial commit

1 files changed, 40 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9043083
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# jdtalk
+
+A silly fortune cookie generator...
+
+## How silly?
+
+```
+unlawful meat justifiably skids
+chicken-hearted sausage characteristically ad-libs
+biomedical beef essentially wiggling
+gristlier baloney gruesomely desire
+to-and-fro felines lumpishly aromatise
+moated waffle suspensively tent
+```
+
+## Compiling
+
+`jdtalk` requires a `D` compiler and `dub`.
+
+```bash
+$ dub build -b release
+```
+
+## Running
+
+```bash
+$ export JDTALK_DATA=$HOME/path/to/data/dir
+$ ./jdtalk
+```
+
+## Usage
+
+```bash
+-c    --limit (default: 0)
+-p  --pattern Limit output to a root word
+-e    --exact Exact matches only (default: false)
+-d --dataroot Path to dictionaries
+-h     --help This help information.
+```
+