README.md aktualisiert

README.md

@@ -1,2 +1,119 @@
 # PulseCast
 
+> ⚠️ **Wichtig:** PulseCast **erfordert die StatusAPI** Version **4.0.5** oder höher!  
+> Ohne die StatusAPI funktioniert das Plugin nicht.  
+> Download & Releases: [StatusAPI Git Repository](https://git.viper.ipv64.net/M_Viper/StatusAPI/releases)
+
+**PulseCast** ist ein WordPress-Plugin, das Broadcast-Nachrichten direkt aus dem WordPress-Backend an deine StatusAPI sendet. Nachrichten können sofort oder zeitgesteuert verschickt werden. Der Plugin-Scheduler unterstützt serverseitige Planung für maximale Zuverlässigkeit.
+
+---
+
+## Features
+
+- Sofortige Broadcasts aus dem WordPress-Backend
+- Geplante Broadcasts mit wiederkehrenden Intervallen (stündlich, täglich, wöchentlich)
+- Globale Einstellungen: Prefix, Prefix-Farbe, Klammerfarbe und Nachrichtenfarbe
+- Serverseitige Synchronisation geplanter Broadcasts
+- Kompatibel mit jeder StatusAPI-Version ≥ 4.0.5, optional mit API-Key
+- Logs der letzten 50 gesendeten Broadcasts
+- Einfache Verwaltung über das WordPress-Admin-Menü
+
+---
+
+## Installation
+
+1. Lade das Plugin-Verzeichnis `pulsecast` in dein WordPress `wp-content/plugins` Verzeichnis hoch.
+2. Aktiviere das Plugin über das WordPress-Admin-Plugin-Menü.
+3. **Installiere die StatusAPI (≥ 4.0.5)** auf deinem Server.  
+   Download & Releases: [StatusAPI Git Repository](https://git.viper.ipv64.net/M_Viper/StatusAPI/releases)
+4. Gehe zu **PulseCast** im Admin-Menü, um die API-Einstellungen zu konfigurieren.
+
+---
+
+## Konfiguration
+
+1. **StatusAPI URL**: Gib die Adresse deines StatusAPI-Servers an (Port und Pfad werden automatisch ergänzt).  
+   Beispiel: `http://example.net`
+2. **API-Key (optional)**: Falls dein StatusAPI-Key erforderlich ist.
+3. **Broadcast Prefix**: Text, der vor jeder Nachricht angezeigt wird (z.B. `[Broadcast]`).
+4. **Prefix-Farbe, Klammerfarbe, Nachrichtenfarbe**: Minecraft-Farbcodes (`&c` Rot, `&8` Dunkelgrau, etc.).
+5. Speichere die Einstellungen.
+
+---
+
+## Verwendung
+
+### Sofortiger Broadcast
+
+1. Gehe zu **PulseCast → Broadcast**.
+2. Gib die Nachricht ein.
+3. Klicke auf **Senden**, um die Nachricht sofort zu verschicken.
+
+### Geplante Broadcasts
+
+1. Gehe zu **PulseCast → Broadcast**.
+2. Gib Nachricht, Zeit (Server-Zeitzone) und optional Wiederholungsintervall ein.
+3. Klicke auf **Planen (serverseitig)**.
+4. Geplante Broadcasts werden automatisch an die StatusAPI gesendet.
+
+### Synchronisation
+
+- Mit der **Synchronisationsfunktion** können alle gespeicherten Zeitpläne erneut an die API gesendet werden.
+- Fehlerhafte Schedules werden protokolliert.
+
+---
+
+## Cron & Wiederholungen
+
+- Wiederholung möglich: `hourly` (stündlich), `daily` (täglich), `weekly` (wöchentlich)
+- Serverseitige Cron-Jobs werden automatisch über WordPress `wp_cron` verwaltet.
+
+---
+
+## Sicherheit & Berechtigungen
+
+- Nur Administratoren (`manage_options`) können Broadcasts senden oder Einstellungen ändern.
+- API-Key kann optional gesetzt werden.
+- Alle Eingaben werden sanitisiert und validiert.
+
+---
+
+## Logs
+
+- Die letzten 50 gesendeten Broadcasts werden gespeichert.
+- Jede Nachricht enthält Meta-Daten (Zeit, Quelle, Zeitzone).
+
+---
+
+## Kompatibilität
+
+- WordPress 5.0+
+- PHP 7.4+
+- StatusAPI ≥ 4.0.5
+
+---
+
+## Beispiel Payload an die API
+
+```json
+{
+  "message": "Hello World!",
+  "type": "global",
+  "prefix": "[Broadcast]",
+  "prefixColor": "&c",
+  "bracketColor": "&8",
+  "messageColor": "&f",
+  "meta": {
+    "source": "PulseCast-WordPress",
+    "time": "2026-01-17T12:00:00Z"
+  }
+}
+```
+
+## Lizenz
+
+Dieses Plugin hat keine Lizenz. Es darf nicht verändert oder weiterverbreitet werden.
+
+## Autor
+
+M_Viper