From d51f409497f03cdd4781b4d4842908f14eb6b123 Mon Sep 17 00:00:00 2001
From: Justin Hawkins <justin@hawkins.id.au>
Date: Fri, 20 Jun 2025 12:17:39 +0200
Subject: [PATCH] Add basic docco

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/README.md b/README.md
index e69de29..4b640f6 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,23 @@
+# charmite
+
+Charmite is a simple TUI to add/view time entries in the [Mite](https://mite.de/en/)
+time tracking tool.
+
+## Installation
+
+Download the appropriate binary from https://code.ppl.town/justin/charmite/releases
+
+Or compile from the source code with:
+
+    go build .
+
+## Using
+
+You'll need to set the environment variables:
+
+* MITE_API
+* MITE_DOMAIN
+
+To appropriate values.
+
+See the [Mite FAQ](https://mite.de/en/faq.html) under "How do I allow API access for my account? Where can I get an API key?" for details on how to obtain your API key.
\ No newline at end of file