From ce889785835c83d048d911d5a1be1890563a046f Mon Sep 17 00:00:00 2001
From: Evelyn Alicke <e.alicke@famedly.com>
Date: Wed, 27 Mar 2024 12:32:22 +0100
Subject: [PATCH] docs: update documentation to be easier to understand

---
 README.md | 81 ++++++++++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 65 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index 2af895b..670d098 100644
--- a/README.md
+++ b/README.md
@@ -1,28 +1,77 @@
-[![CI](https://github.com/famedly/openmetrics-vici-expoter/actions/workflows/build.yml/badge.svg?event=release)](https://github.com/famedly/openmetrics-vici-expoter/actions/workflows/build.yml)
-
 # openmetrics-vici-exporter
 
-provides an openmetrics compatible endpoint for strongSwan charon's VICI.
-initally tested against strongSwan 5.9 and strongSwan 6.0.
-
-## deployment
-pull container image from `ghcr.io`, see `docker-compose.yml` in this repo
+Provides an openmetrics compatible endpoint for strongSwan charon's VICI.
 
 
-## development
+## Features
 
-1. `sudo groupadd vici`
-2. `sudo chown root:vici /var/run/charon.vici`
-3. `sudo chmod 0770 /var/run/charon.vici`
-4. `sudo usermod -aG vici $user`
-5. `cargo run`
-6. `curl http://localhost:8001/metrics`
+as of `v0.1.0` the following metrics are exporterd:
 
+| name | |
+|------|-|
+|`sa_uptime`| seconds since state changed to up |
+|`sa_rekey_time`||
 
-## license
+| name |
+|`sa_child_bytes_in`|
+|`sa_child_bytes_out`|
+|`sa_child_packets_in`|
+|`sa_child_packets_out`|
+
+### Planned Features:
+* `v0.2.0`
+    * an info metric showing the applied configuration
+    * an enum metric showing the current state / queued jobs per connection
+
+## Usage
+
+### Deployment
+You have a few options avalible:
+1. [Binary Releases](/releases)
+2. Docker Image
+    * `docker-oss.nexus.famedly.de/openmetrics-vici-exporter
+
+### Configuration
+
+All values have defaults, no configuration is necessary, but an exhaustive default configuration is still provided, see [`config.yml`](/blob/main/config.yml).
+
+You can also set these as environment variables, prefixed with `VICI_EXPORTER`
+
+| Key | Default | |
+|-----|---------|-|
+|`vici.socket`|`/var/run/charon.vici`| unix socket where vici is reachable |
+|`vici.interval`|`10`| how often to get data from the vici, in seconds |
+|`server.address`|`0.0.0.0`| any bind address, ipv6 is also allowed `[::1]`|
+|`server.port`|`8000`||
+
+## Development
+
+if you'd like to contribute you are free to do so.
+
+we provide a nix flake (`nix develop`) to setup the rust enviroment for you, but there's still some manual setup to do.
+
+you need charon running with the vici plugin enabled in the configuration.
+
+make sure your user has the required permissions to access the vici socket.
+
+on a debian system you can just run the following to give yourself access:
+
+``` bash
+sudo groupadd vici
+sudo chown root:vici /var/run/charon.vici
+sudo chmod 0770 /var/run/charon.vici
+sudo usermod -aG vici $(whoami)
+```
+
+` cargo run && curl http://[::1]:8001/metrics `
+
+## License
 
 [AGPL-3.0-only](LICENSE.md)
 
-## authors
+## Authors
+
+This software is authored and maintained as open-source by Famedly's Infrastructure Team.
 
 - Evelyn Alicke <e.alicke@famedly.com>
+- Famedly GmbH <info@famedly.com>