From e8cdfb4e66a2ec648b3e59966be958a9d74976e7 Mon Sep 17 00:00:00 2001
From: Nirodan <nirodan.production@gmail.com>
Date: Sat, 14 Jun 2025 19:06:13 +0200
Subject: [PATCH] Angepasste Readme

---
 README.md | 24 +++++++++++++++++-------
 1 file changed, 17 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 7059a96..a60112a 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,22 @@
-# React + Vite
+# 🐳 Docker-Webplattform: React + Flask + externe MariaDB
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+Dieses Projekt ist eine vollständig dockerisierte Webanwendung, die ein React-Frontend und ein Flask-Backend **in einem einzigen Container** vereint. Sie kommuniziert mit einer **externen MariaDB-Datenbank** (z. B. auf einem Unraid-Server) und bietet ein Setup-System, Login, Rollenverwaltung und modulare Tools.
 
-Currently, two official plugins are available:
+---
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+## ⚙️ Was macht der Docker-Container?
 
-## Expanding the ESLint configuration
+- 🚀 Startet automatisch **Flask + React** in einer Umgebung
+- 🛠 Bei Erststart zeigt er eine **Setup-Webseite** zum Eintragen der DB-Verbindung
+- 💾 Speichert die Konfiguration in `config/db_config.json`
+- 🌐 Verbindet sich mit der **externen MariaDB-Datenbank**
+- 👤 Erstellt automatisch ein `admin`-Benutzerkonto (`admin / admin`)
+- 🔐 Ermöglicht Login und Rollenzuordnung
+- 🧰 Liefert das React-Frontend direkt über Flask aus (keine extra Node-Instanz)
+- 🧾 Verwaltet Tools wie z. B. ein MD5-Hash-Modul
+- ✅ Docker-fähig, kompatibel mit Docker Compose oder Portainer
+
+---
+
+## 📦 Projektstruktur
 
-If you are developing a production application, we recommend using TypeScript with type-aware lint rules enabled. Check out the [TS template](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) for information on how to integrate TypeScript and [`typescript-eslint`](https://typescript-eslint.io) in your project.