Initial commit

README.md

@@ -0,0 +1,95 @@
+# Expense Tracker Add-on für Home Assistant
+
+Dieses Home Assistant Add-on bietet eine komfortable Möglichkeit, persönliche oder Haushaltsausgaben direkt innerhalb von Home Assistant zu verfolgen und zu analysieren.
+
+## Features
+
+- **Erfassung von Ausgaben**: Erfasse manuell oder automatisiert via API deine täglichen, wöchentlichen oder monatlichen Ausgaben.
+- **Kategorisierung**: Ordne Ausgaben in selbst definierbare Kategorien wie Lebensmittel, Transport, Freizeit, etc., um einen besseren Überblick über dein Budget zu erhalten.
+- **Integration in Dashboards**: Binde Ausgabendiagramme und Statistiken direkt in deine Home Assistant Dashboards ein.
+- **Datensicherheit**: Alle Daten bleiben lokal in deinem Home Assistant-System und werden nicht an Dritte weitergegeben.
+
+## Installation
+
+1. Navigiere in Home Assistant zu **Einstellungen** → **Add-ons** → **Add-on Store**
+2. Klicke auf die drei Punkte in der oberen rechten Ecke und wähle **Repositories**
+3. Füge die URL dieses Repositories hinzu
+4. Suche nach "Expense Tracker" in der Add-on Liste und installiere es
+5. Starte das Add-on und aktiviere "Show in sidebar"
+
+## Verwendung
+
+### Ausgaben erfassen
+
+1. Öffne das Add-on über die Seitenleiste
+2. Navigiere zum Tab "Ausgaben"
+3. Fülle das Formular aus mit:
+   - Betrag
+   - Beschreibung
+   - Kategorie
+   - Datum
+4. Klicke auf "Ausgabe speichern"
+
+### Kategorien verwalten
+
+1. Navigiere zum Tab "Kategorien"
+2. Füge neue Kategorien hinzu oder sieh dir bestehende an
+
+### Berichte anzeigen
+
+1. Navigiere zum Tab "Berichte"
+2. Filtere nach Zeitraum, um spezifische Daten anzuzeigen
+3. Betrachte die Ausgabenverteilung nach Kategorien und den zeitlichen Verlauf
+
+## API-Integration
+
+Das Add-on bietet eine REST-API zur Integration mit anderen Systemen:
+
+### Ausgaben hinzufügen
+
+```
+POST /api/expenses
+Content-Type: application/json
+
+{
+  "amount": 12.99,
+  "description": "Mittagessen",
+  "category_id": 1,
+  "date": "2025-05-30T12:00:00"
+}
+```
+
+### Ausgaben abrufen
+
+```
+GET /api/expenses
+```
+
+### Kategorien abrufen
+
+```
+GET /api/categories
+```
+
+## Dashboard-Integration
+
+Um Expense Tracker-Widgets in dein Home Assistant Dashboard einzubinden, kannst du die iframe-Karte verwenden:
+
+```yaml
+type: iframe
+url: /api/hassio_ingress/self_slug
+aspect_ratio: 75%
+title: Ausgaben
+```
+
+## Daten-Backup
+
+Die Datenbank wird im `/data`-Verzeichnis des Add-ons gespeichert und wird automatisch in den regulären Home Assistant-Backups gesichert.
+
+## Support
+
+Bei Fragen oder Problemen öffne bitte ein Issue im GitHub-Repository.
+
+## Lizenz
+
+Dieses Projekt ist unter der MIT-Lizenz veröffentlicht.