diff --git a/README.md b/README.md index a0650a7..666f158 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,41 @@ # StatusPulse +![Plugin](https://img.shields.io/badge/StatusPulse-WordPress%20Plugin-0B63CE?style=for-the-badge&logo=wordpress&logoColor=white) +![StatusAPI](https://img.shields.io/badge/StatusAPI-%E2%89%A5%204.1.0-1E9E5A?style=for-the-badge) +![Scope](https://img.shields.io/badge/Scope-Admin%20Only-D48700?style=for-the-badge) +![Endpoint](https://img.shields.io/badge/Attack%20Endpoint-POST%20%2Fnetwork%2Fattack-6F42C1?style=for-the-badge) + +Moderne WordPress-Admin-Erweiterung für das StatusAPI-Projekt. + +## Voraussetzung + +- StatusAPI ab Version 4.1.0 +- Erreichbare StatusAPI-Basis-URL +- Gültiger `networkinfo.attack.api_key` aus `network-guard.properties` + +## Zweck + +StatusPulse bietet eine reine Admin-Oberfläche im WordPress-Backend, um die Verbindung zu StatusAPI schnell zu testen und die wichtigsten Werte zentral zu verwalten. + +## Funktionen + +- Konfiguration von: + - `networkinfo.attack.api_key` + - `networkinfo.attack.source` + - StatusAPI-Basis-URL +- Direkte Test-Buttons für Proxy-Status und Attack-Endpunkt +- Verbindungsprüfung zur StatusAPI +- Test-Attack-Meldung an `POST /network/attack` +- Copy-Snippets für die Übernahme in `network-guard.properties` + +## Installation + +1. Ordner `statuspulse` nach `wp-content/plugins/` kopieren. +2. Plugin in WordPress aktivieren. +3. Im Admin-Menü `StatusPulse` öffnen. +4. Basis-URL, Attack-Key und Source eintragen. +5. Werte in `network-guard.properties` übernehmen. + +## Hinweis + +Das Plugin ist absichtlich auf den Admin-Bereich fokussiert.