From a4eaa53b2332c3ae8e1bebab4b97f4e57b196086 Mon Sep 17 00:00:00 2001
From: Martin Dvorak <dvorak@dvorakmortonxd.dev>
Date: Fri, 4 Sep 2026 10:56:26 +0200
Subject: [PATCH] Updated README.md to fit current situation

---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dece6c5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# QoL-tweaks
+
+A quality-of-life SMP plugin for Paper/Folia.
+
+## Features
+
+- **Join messages** — friendly welcome messages, including a first-join message that lists the server's plugins, and a special announcement when the owner logs in.
+- **`/nopvp`** — toggle no-PvP mode. While active you cannot damage other players and other players cannot damage you (direct hits and projectiles). While enabled you also glow so everyone can see you're protected. Turning no-PvP *off* starts a **1-hour cooldown** before you can enable it again, and the state persists across restarts so relogging can't bypass it.
+
+## Commands
+
+| Command  | Description                                                              | Permission            |
+|----------|--------------------------------------------------------------------------|-----------------------|
+| `/nopvp` | Toggle no-PvP mode (damage immunity vs. players + player glow).          | `qoltweaks.nopvp`     |
+
+All permissions default to `true`.
+
+## Data
+
+Player no-PvP state and cooldown timestamps are stored in `plugins/qol-tweaks/nopvp.yml` so they survive restarts and reloads.
+
+## Compatibility
+
+- Built against the Paper API and marked `folia-supported: true`, so it runs on both Paper and Folia. Region-aware scheduling is used for persistence writes.
+- Java 25 toolchain.
+
+## Building
+
+```bash
+./gradlew build
+```
+
+The plugin jar is output to `build/libs/`.
+
+## License
+
+See [LICENSE](LICENSE).