This commit is contained in:
23
README.md
23
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.
|
||||||
Reference in New Issue
Block a user