docs: meaningful README with install/config guide

2026-05-05 06:07:02 +02:00
parent 0e31bf55e5
commit 428090abd5
1 changed files with 63 additions and 1 deletions
@@ -1,3 +1,65 @@
 # Hermes_rocket.chat_Plugin

-Stellt einen nativen Chatclient für das Hermes Agent Gateway bereit
+> Offizielles Rocket.Chat Platform-Plugin für [Hermes Agent](https://hermes-agent.nousresearch.com/)
+
+Stellt einen nativen Chatclient für das Hermes Agent Gateway bereit — mit Echtzeit-Nachrichten via WebSocket/DDP und REST-API für ausgehende Antworten.
+
+## Features
+
+- **Echtzeit-Streaming**: WebSocket/DDP für sofortige eingehende Nachrichten
+- **Präsenz-Status**: Grüner Online-Indikator im Rocket.Chat
+- **Markdown-Support**: Fett, kursiv, Inline-Code, Code-Blöcke, Links
+- **Interaktive Buttons**: Ja/Nein, Bestätigen/Abbrechen, Mehrfachauswahl
+- **Raum-Unterstützung**: Kanäle, private Gruppen, Direktnachrichten
+- **Allowlist**: Steuerung, wer den Bot nutzen darf
+
+## Installation
+
+```bash
+# In dein Hermes Agent Verzeichnis wechseln
+cd ~/.hermes/hermes-agent
+
+# Plugin-Verzeichnis anlegen
+mkdir -p plugins/platforms/rocketchat
+
+# Diese drei Dateien hineinkopieren:
+cp plugin.yaml   plugins/platforms/rocketchat/
+cp __init__.py   plugins/platforms/rocketchat/
+cp adapter.py    plugins/platforms/rocketchat/
+```
+
+## Konfiguration
+
+### Über Umgebungsvariablen
+
+```bash
+export ROCKETCHAT_BASE_URL="https://rocketchat.example.com"
+export ROCKETCHAT_USER="bernd"
+export ROCKETCHAT_PASSWORD="dein-passwort"
+export ROCKETCHAT_ROOM_ID="J3jvMyrKTMzKvKHSh"      # optional
+export ROCKETCHAT_ALLOWED_USERS="andreas,max"       # optional
+export ROCKETCHAT_ALLOW_ALL_USERS="false"           # default
+```
+
+### Über `config.yaml`
+
+```yaml
+plugins:
+  platforms:
+    rocketchat:
+      enabled: true
+      base_url: "https://rocketchat.example.com"
+      user: "bernd"
+      password: "dein-passwort"
+      room_id: "J3jvMyrKTMzKvKHSh"      # optional
+      allowed_users: ["andreas", "max"] # optional
+      allow_all_users: false            # default
+```
+
+## Abhängigkeiten
+
+Keine externen Pakete erforderlich — nutzt ausschließlich Python-Standardbibliothek (`urllib`, `socket`, `ssl`, `threading`).
+
+## Lizenz
+
+[Unlicense](LICENSE) — Public Domain