README.md aktualisiert

README.md

@@ -1,2 +1,38 @@
-# PlaceholderSign
+# PlaceholderSIGN
 
+Ein Minecraft-Plugin für Spigot/Paper-Server, das dynamische Schilder mit PlaceholderAPI-Unterstützung ermöglicht. Schilder können Platzhalter wie `%player_gamemode%`, `%player_health%` oder andere von PlaceholderAPI bereitgestellte Platzhalter anzeigen und aktualisieren sich automatisch in Echtzeit.
+
+## Features
+- **Dynamische Schilder**: Erstelle Schilder mit Platzhaltern, die sich automatisch basierend auf Spieleraktionen aktualisieren.
+- **PlaceholderAPI-Unterstützung**: Nutzt Platzhalter wie `%player_gamemode%`, `%player_name%`, `%player_health%` usw.
+- **Sofortige Updates**: Unterstützt sofortige Aktualisierungen bei Ereignissen wie Gamemode-Änderungen, Schaden, Level-Änderungen und mehr.
+- **RGB-Farben**: Unterstützt Hex-Farben für ansprechende Schild-Designs (in kompatiblen Minecraft-Versionen).
+- **Konfigurierbare Einstellungen**: Passe die Reichweite, Scroll-Geschwindigkeit und Update-Frequenz an.
+
+## Voraussetzungen
+- **Minecraft-Version**: 1.18 oder höher (für RGB-Unterstützung empfohlen: 1.16+)
+- **Server**: Spigot oder Paper
+- **PlaceholderAPI**: Erforderlich für Platzhalter-Funktionalität
+- **Java**: 17 oder höher
+
+## Installation
+1. Lade die neueste `PlaceholderSIGN.jar` aus den [Releases](https://git.viper.ipv64.net/M_Viper/PlaceholderSign/releases) herunter.
+2. Platziere die `PlaceholderSIGN.jar` im `plugins`-Ordner deines Servers.
+3. Stelle sicher, dass [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) installiert ist.
+4. Starte den Server, um die Standardkonfiguration (`config.yml`) zu generieren.
+5. Passe die `config.yml` im Ordner `plugins/PlaceholderSIGN` nach Bedarf an.
+
+## Konfiguration
+Die Konfigurationsdatei (`config.yml`) befindet sich im Ordner `plugins/PlaceholderSIGN`. Standardwerte:
+
+```yaml
+version: "3.0.0"
+no_permission: "&cDu hast keine Berechtigung!"
+usage_correct: "&cVerwendung: /editsign <Zeile> <Text>"
+invalid_number: "&cBitte gib eine gültige Zeilennummer (1-4) an!"
+aborted_action: "&cAktion abgebrochen!"
+click_to_edit: "&aKlicke auf ein Schild, um es zu bearbeiten!"
+update_message: "&aSchild aktualisiert!"
+sign-minimum-distance: 10
+scroll-time: 20
+update-interval: 1