From 635606b845673e7ef6b6a1cd70ec9df69dfbd734 Mon Sep 17 00:00:00 2001
From: Thomas Basler <thomas@familie-basler.net>
Date: Thu, 16 Jun 2022 10:40:26 +0200
Subject: [PATCH] Added first Readme.md file

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..958d794
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# OpenDTU
+
+## Background
+This project was started from [this](https://www.mikrocontroller.net/topic/525778) discussion (Mikrocontroller.net).
+It was the goal to replace the original Hoymiles DTU (Telemetry Gateway) with their cloud access. With a lot of reverse engineering the Hoymiles protocol was decrypted and analyzed.
+
+
+## Features for end users
+* Uses ESP32 mikrocontroller and NRF24L01+
+* Multi-Inverter support
+* MQTT support
+* Nice and fancy WebApp with visualisation of current data
+
+## Features for developers
+* The mikrocontroller part
+    * Build with Arduino PlatformIO Framework for the ESP32
+    * Uses [ESPAsyncWebserver](https://github.com/me-no-dev/ESPAsyncWebServer) and [Async MQTT client](https://github.com/marvinroger/async-mqtt-client)
+
+* The WebApp part
+    * Build with [Vue.js](https://vuejs.org)
+
+## Building
+* Building the WebApp
+    * The WebApp can be build using yarn
+    ```
+    $ yarn install
+    $ yarn build
+    ```
+    * The updated output is placed in the 'data' directory
+
+* Building the mikrocontroller firmware
+    * Visual Studio Code with the PlatformIO Extension is required for building