README.md aktualisiert

2026-05-11 07:15:21 +00:00
parent acafbb0525
commit b277a9be06
1 changed files with 129 additions and 1 deletions
--- a/README.md
+++ b/README.md
@@ -1,2 +1,130 @@
-# Minecraft-Server-News
+# ⛏ Minecraft Server News – WordPress Plugin

+> Ein WordPress Plugin speziell für Minecraft-Server-Betreiber. Veröffentliche Updates, Events und Ankündigungen direkt auf deiner Website – mit modernem Dark-Design im Viper-Network-Stil.
+
+---
+
+## ✨ Features
+
+- 📋 **Eigener Post-Type** – „Server News" als eigener Bereich im WordPress-Admin
+- 📂 **Kategorien** – Update, Event, Wartung, Wichtig, Community (automatisch angelegt)
+- 📌 **Anpinnen** – Wichtige News bleiben immer ganz oben
+- 🏷️ **Badges** – NEU, WICHTIG, HOT, BETA, LIVE *(blinkt)*, BALD
+- 🖥️ **Server-IP** pro News mit 1-Klick-Kopieren
+- 🔍 **Live-Filter** – nach Kategorie filtern ohne Seitenreload
+- 📦 **Shortcode** – News auf jeder beliebigen Seite einbetten
+- 🗂️ **Widget** – Letzte News in der Sidebar anzeigen
+- 🎨 **Dark-Theme** im Cyan/Türkis-Stil passend zum Viper Network
+
+---
+
+## 🚀 Installation
+
+1. Repository als ZIP herunterladen
+2. In WordPress: **Plugins → Neu hinzufügen → Plugin hochladen**
+3. ZIP auswählen und hochladen
+4. Plugin **aktivieren**
+
+> Beim Aktivieren werden die Standard-Kategorien und Permalink-Struktur automatisch eingerichtet.
+
+---
+
+## 🔧 Verwendung
+
+### Shortcode
+
+Füge den Shortcode auf einer beliebigen WordPress-Seite ein:
+
+```
+[server_news]
+```
+
+**Optionale Parameter:**
+
+| Parameter | Standard | Beschreibung |
+|-----------|----------|-------------|
+| `anzahl` | `10` | Anzahl der angezeigten News |
+| `kategorie` | – | Slug(s) filtern, z.B. `update,event` |
+| `layout` | `grid` | `grid` oder `list` |
+
+**Beispiele:**
+
+```
+[server_news anzahl="6"]
+[server_news kategorie="update,event" layout="grid"]
+[server_news layout="list" anzahl="5"]
+```
+
+---
+
+## 📂 Dateistruktur
+
+```
+minecraft-server-news/
+├── minecraft-server-news.php   # Haupt-Plugin-Datei
+├── includes/
+│   ├── post-type.php           # Custom Post Type Registrierung
+│   ├── taxonomy.php            # Kategorien (Taxonomie)
+│   ├── metaboxes.php           # Pinnen, Badge, Server-IP
+│   ├── shortcode.php           # [server_news] Shortcode
+│   ├── widget.php              # Sidebar-Widget
+│   ├── assets.php              # CSS/JS einbinden
+│   └── admin-columns.php       # Extra-Spalten im Admin
+└── assets/
+    ├── css/
+    │   ├── mcn-style.css       # Frontend Dark-Theme
+    │   └── mcn-admin.css       # Admin-Bereich Styles
+    └── js/
+        └── mcn-script.js       # Filter & IP-Kopieren
+```
+
+---
+
+## 🏷️ Kategorien
+
+Folgende Kategorien werden beim Aktivieren automatisch erstellt:
+
+| Emoji | Kategorie |
+|-------|-----------|
+| 🔄 | Update |
+| 🎉 | Event |
+| 🔧 | Wartung |
+| ⚠️ | Wichtig |
+| 👥 | Community |
+
+Eigene Kategorien können unter **Server News → Kategorien** hinzugefügt werden.
+
+---
+
+## ⚙️ News erstellen
+
+1. Im WordPress-Admin auf **⛏ Server News → Neu** klicken
+2. Titel und Inhalt verfassen
+3. In der rechten Sidebar:
+   - Kategorie auswählen
+   - Optional: **Anpinnen** aktivieren
+   - Optional: **Badge** wählen (NEU, WICHTIG, HOT …)
+   - Optional: **Server-IP** eintragen
+4. Beitragsbild hochladen
+5. Veröffentlichen
+
+---
+
+## 🛠️ Anforderungen
+
+| | Mindestversion |
+|---|---|
+| WordPress | 5.8+ |
+| PHP | 7.4+ |
+
+---
+
+## 📄 Lizenz
+
+Dieses Plugin wurde für das **Viper Network** entwickelt und ist für den privaten Gebrauch auf der eigenen WordPress-Installation bestimmt.
+
+---
+
+<div align="center">
+  <sub>Entwickelt für den Viper Network Minecraft-Server</sub>
+</div>