master upload

README.md

@@ -1,3 +1,47 @@
-# sc-ntfy-plugin
+# NTFYNotifier
 
-This is a minecraft plugin for the use with ntfy server for notifications
+A lightweight Minecraft plugin that sends real-time alerts to [ntfy.sh](https://ntfy.sh) when players join, leave, or run specific commands. Designed for Paper/Spigot servers on Minecraft 1.14+, this plugin helps admins stay in-the-know wherever they are.
+
+---
+
+## 🔔 Features
+
+- 🔹 Join and Quit Notifications
+- 🔹 Command Watcher (customizable)
+- 🔹 `%player%` and `%server%` placeholder support
+- 🔹 Fully configurable messages and settings
+- 🔹 ntfy.sh API integration (with optional basic auth)
+
+---
+
+## 🛠 Installation
+
+1. Place the compiled `NTFYNotifier-1.0.0.jar` in your server’s `plugins/` folder.
+2. Start the server to generate `config.yml` and `msg.yml`.
+3. Customize configuration and messages to your liking.
+
+---
+
+## ⚙ Configuration
+
+### `config.yml`
+```yaml
+server-name: "NTFYCraft"
+
+ntfy:
+  server: "https://ntfy.sh"
+  topic: "minecraft-events"
+  auth:
+    enabled: false
+    username: "user"
+    password: "pass"
+
+notifications:
+  join: true
+  quit: true
+  commands:
+    enabled: true
+    watch:
+      - "stop"
+      - "ban"
+      - "kick"