Merge pull request #13 from SLNE-Development/feat/readme

docs: Update README

Author: MikeyLLP

README.md

@@ -1 +1,76 @@
-# surf-moderation-tools
+# 🌊 Surf Moderation Tools
+
+**Surf Moderation Tools** is a Minecraft plugin designed to help supporters and moderators work more efficiently. It
+provides quick administrative and support functions directly in-game.
+
+## ⚡ Commands
+
+### Player Management
+
+- **`/rotate <Player>`**   
+  🔄 Rotate a player without teleporting them.
+
+- **`/freeze <Player> <time<s,m,h,d,w>>`**   
+  ❄️ Freeze a player for a specific duration.
+
+- **`/unfreeze <Player>`**   
+  ☀️ Unfreeze a player.
+
+- **`/faq <FAQ> [Player]`**  
+  📄 Send pre-defined answers to frequently asked questions.
+
+    - If no player is specified, the FAQ is sent to all relevant viewers.
+    - If a player is specified, only that player receives the FAQ **and gets pinged** with a notification sound.
+
+  <details>
+    <summary>📄 Current FAQs (click to expand)</summary>
+
+    - Ask
+    - BenefitsAsVeteran
+    - ClanInformation
+    - HowToCreatePlot
+    - HowToInstallVoiceChat
+    - HowToJoin
+    - HowToOpenTicket
+    - NextEvent
+    - ReadTheDocs
+    - ReportBug
+    - ReportPlayer
+    - Rulebook
+    - ServerModpack
+    - SurvivalDowntime
+    - TakePartInEvent
+    - WhyNoElytraInTheEnd
+    - WhyNoTeleportation
+    - WhyNoVillagers
+  </details>
+
+### Admin
+
+- **`/surfmodtools setMessageCooldown <time(ms)>`**   
+  ⚙️ Set the FAQ message cooldown.
+
+- **`/surfmodtools reload`**   
+  ⚙️ Reload the plugin config without restarting the server.
+
+## 🛠 Installation
+
+1. Download the latest release from [GitHub Releases](https://github.com/SLNE-Development/surf-moderation-tools).
+2. Ensure the following dependencies are installed:
+    - [Surf API](https://github.com/SLNE-Development/surf-api)
+    - [Surf Bitmap Provider](https://github.com/SLNE-Development/surf-bitmap-provider)
+3. Make sure **Java 24** is installed.
+4. Place the plugin in your server's `plugins` folder and restart the server.
+
+## ⚙️ Configuration
+
+- You can configure the FAQ duration in the config file to prevent multiple supporters from sending the same FAQ at the
+  same time.
+
+## 📜 License
+
+This project is licensed under the **GNU General Public License v3.0 (GPL-3.0)**.
+
+---
+
+NOT AN OFFICIAL MINECRAFT PRODUCT. NOT APPROVED BY OR ASSOCIATED WITH MOJANG OR MICROSOFT.