added README.md

README.md

@@ -0,0 +1,30 @@
+# Mite-go
+
+A [https://mite.yo.lk/en/](MITE) time tracking command line interface.
+
+## Setup
+
+1. Grab a release from https://github.com/leanovate/mite-go/releases for your operating system and unpack it into your
+$PATH (or %PATH% on windows).
+2. Setup mite-go to use your API key by:
+ 1. visiting https://<your account name here>.mite.yo.lk/myself and note down the API key
+ 2. executing the following commands
+ `mite-go config api.key=<your API key here>`
+ `mite-go config api.url=https://<your account name here>.mite.yo.lk`
+3. Optional: set a default project & service by:
+ 1. retrieving the desired project & service id by executing `mite-go projects` and `mite-go services` respectively
+ 2. configuring those id's as default by executing `mite-go config projectId=<the project id>` and `mite-go config serviceId=<the service id>`
+
+# Usage
+
+Supported sub-commands:
+
+| config   | sets or reads a config property                   |
+|----------|---------------------------------------------------|
+| entries  | lists & adds time entries                         |
+| help     | Help about any command                            |
+| projects | list & adds projects                              |
+| services | list & adds services                              |
+| tracker  | starts, stops and shows the status of the tracker |
+
+For an up-to-date usage check `mite-go help`.