From 6ae2334ffaea9d403d3cf4e2911c3dd512b7284b Mon Sep 17 00:00:00 2001
From: Leo <leonard.habrom@uni-ulm.de>
Date: Thu, 7 May 2026 14:34:48 +0200
Subject: [PATCH] feat: add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..884d6a7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,7 @@
+# Custom Server Icons for Velocity Hostnames
+## Usage:
+- Launch proxy with the plugin once so the data directory gets created or create the directory `custom-server-icon` in the `plugins` folder manually
+- Put server icons as png with 64x64 pixels size into the data directory.
+- Rename the icons to `<hostname>.png` example: `mc.leohabrom.com.png`.
+- The forced hosts should now display their custom icons accordingly.
+- To reload the icons from the directory without restarting, use the command `/reload-icons`
\ No newline at end of file