Add basic docco
All checks were successful
CI / test (push) Successful in 36s

This commit is contained in:
Justin Hawkins 2025-06-20 12:17:39 +02:00
parent e7fa789b2b
commit d51f409497

View File

@ -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.