Add README.md

README.md

@@ -0,0 +1,27 @@
+# lmcli
+
+`lmcli` is a (Large) Language Model (and maybe other types of models) CLI.
+
+It currently allows you to perform one-shot prompts with `lmcli prompt
+<message>`, and persisted conversations are underway.
+
+## Install
+
+```shell
+$ go install git.mlow.ca/mlow/lmcli@latest
+
+```
+
+## Usage
+
+Invoke `lmcli` at least once:
+
+```shell
+$ lmcli help
+```
+
+Edit `~/.config/lmcli/config.yaml` and set `openai.apiKey` to your API key.
+
+Refer back to the output of `lmcli help` for usage.
+
+Enjoy!