Require permission to rehash for rehash and disconnect

[irc/unrealircd/unrealircd-webpanel.git] / README.md

diff --git a/README.md b/README.md
index d178185f3431b55530b8355b15ebc9d549b9c6cf..eead3e71c2a5ec7be9b7d70a5b5e1e0df676a9ea 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,24 @@
-# unrealircd-webpanel
- UnrealIRCd Administration WebPanel
+ ## UnrealIRCd Administration WebPanel
+ 
+[![Version](https://img.shields.io/badge/UnrealIRCd-6.1.0_or_later-darkgreen.svg)]()
+[![Version](https://img.shields.io/badge/Version-0.9-blue.svg)]()
+[![Maintained](https://img.shields.io/badge/Maintained-yes-darkgreen.svg)]()
+[![Unreal](https://img.shields.io/badge/PHP-8.0_or_later-darkgreen.svg)](https://unrealircd.org)
+
+The UnrealIRCd Administration WebPanel gives you an overview of your IRC network,
+with detailed information about servers, users and channels.
+You can easily add and remove server bans, spamfilters and do other administrative tasks,
+all from the convenience of your web browser.
+
+## Example Overview from Desktop
+ <img src="https://i.ibb.co/p4XZ1gx/Screenshot-from-2024-04-15-05-48-46.png">
+ <img src="https://i.ibb.co/6vQ6wg7/spamfilter.png">
+
+## Example Overview from Mobile
+<div class="row">
+<img src="https://i.ibb.co/MZrLCMv/Screenshot-from-2024-04-12-00-51-49.png" height="30%" width="30%">
+<img src="https://i.ibb.co/JtM9rY9/Screenshot-from-2024-04-12-00-52-09.png" height="30%" width="30%">
+</div>
+
+## Installation ##
+See https://www.unrealircd.org/docs/UnrealIRCd_webpanel for all documentation.