From 5139d8460293b2cc711b2d03e6a9ea3600314c05 Mon Sep 17 00:00:00 2001
From: Linus Dietz <45101649+Dielee@users.noreply.github.com>
Date: Sun, 18 Jun 2023 21:33:23 +0200
Subject: [PATCH] Add install instructions

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

diff --git a/README.md b/README.md
index f3461ab..c253e9e 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,21 @@
-# volvo2mqtt
-Home Assistant addon for connecting AAOS Volvos
+# Volvo2Mqtt
+
+This component establishes a connection between the newer AAOS Volvo cars and Home Assistant via MQTT.<br>
+Maybe this component works also with other Volvo cars. Please try out the native Volvo [integration](https://www.home-assistant.io/integrations/volvooncall/) before using this component! If the native component doesn't work for your car, try this mqtt bridge.
+
+## Setup
+
+Just install this addon with the following command.
+Please note to fill in your settings inside the environment variables.
+
+`docker run -e CONF_updateInterval=300 -e CONF_babelLocale='de' -e CONF_mqtt='@json {"broker": "", "username": "", "password": ""}' -e CONF_volvoData='@json {"username": "", "password": "", "vin": ""}' -e TZ='' --name volvo2mqtt ghcr.io/dielee/volvo2mqtt:main`
+
+Here is what every option means:
+
+| Name                 |   Type    |   Default    | Description                                                     |
+| -------------------- | :-------: | :----------: | --------------------------------------------------------------- |
+| `updateInterval`     | `int`     | **required** | Updateintervall in seconds.                                     |
+| `babelLocale`        | `string`  | **required** | Locale for date Format                                          |
+| `mqtt`               | `json`    | **required** | Broker = Mqtt Broker IP / Username and Passwort are optional!   |
+| `volvoData`          | `json`    | **required** | Username and password are required. Car vin is optional. If no vin is provided, the system will always use the first vehicle in API.                                        |
+| `TZ`                 | `string`  |              | Container timezone eg "Europe/Amsterdam" |