Updated readme

Author: kris701

main.go

@@ -33,7 +33,7 @@ func main() {
 		Type:          plugin.PluginType_Utilities,
 		VersionMajor:  0,
 		VersionMinor:  1,
-		VersionPatch:  0,
+		VersionPatch:  1,
 		UIPath: UI_PATH,
 	})
 	if err != nil {

readme.md

@@ -1,15 +1,27 @@
 # Zoraxy Fail2ban Plugin
 
-Test
+This is a simple plugin for [Zoraxy](https://github.com/tobychui/zoraxy) that enables you to use the [Fail2Ban](https://github.com/fail2ban/fail2ban) daemon to block spam bots and scapers. This plugin is mostly just the visual interface in Zoraxy, which includes some simple controls such as updating configs or manually banning IPs.
+
+<img width="1897" height="935" alt="image" src="https://github.com/user-attachments/assets/1aefb7bf-49b2-4700-bc0a-7ee70b63becc" />
 
 # Installation
+To use this plugin, you must first have fail2ban installed.
+
+## Fail2Ban
+
+All the following steps is assumed to be run with `sudo -i` or as a root user.
+
+First install fail2ban from the APT repository:
 
 ```bash
-sudo -i
 apt update
 apt upgrade
 apt install fail2ban
+```
+
+Then you can create the filter that we need to parse Zoraxy log files. You can also change the config values later in Zoraxy.
 
+```bash
 rm /etc/fail2ban/jail.d/*.conf
 cat <<EOF >/etc/fail2ban/filter.d/zoraxy.conf
 [Definition]
@@ -18,8 +30,11 @@ cat <<EOF >/etc/fail2ban/filter.d/zoraxy.conf
 failregex = \[client:\s*<HOST>\].*(GET|POST|HEAD|PUT|DELETE|OPTIONS)\s+/(?!favicon\.ico|robots\.txt|api/notes/|api/renew|apple-touch-icon(?:-[^/]+)?(?:-precomposed)?\.png)[^\s]*\s+(401|403|404|429|444)
 EOF
 chmod 777 /etc/fail2ban/filter.d/zoraxy.conf
+```
 
+Then you can create the fail2ban jail config, where you can change settings to your needs. You can also change the config values later in Zoraxy.
 
+```bash
 cat <<EOF >/etc/fail2ban/jail.local
 # /etc/fail2ban/jail.local
 [DEFAULT]
@@ -46,17 +61,26 @@ bantime.maxtime = 720h
 banaction = nftables-allports
 EOF
 chmod 777 /etc/fail2ban/jail.local
+```
 
+Finally you can restart fail2ban and allow non-root users to modify the fail2ban socket (This is needed for restarting and updating configs).
+
+```bash
 systemctl restart fail2ban
 
 chmod 777 /var/run/fail2ban/fail2ban.sock
 ```
 
-Then
+## Plugin
+
+You can now install the Zoraxy plugin itself, by doing the following:
 
 ```bash
 mkdir -p /opt/zoraxy/plugins/zoraxyfail2ban
 cd /opt/zoraxy/plugins/zoraxyfail2ban
-wget https://github.com/kris701/ZoraxyFail2BanPlugin/releases/download/v0.1.0/zoraxyfail2ban
+# wget <LINK_TO_LATEST_BINARY>
+wget https://github.com/kris701/zoraxyfail2ban/releases/download/v0.1.1/zoraxyfail2ban
 chmod +x zoraxyfail2ban
-```
+```
+
+Then you can restart your Zoraxy server or service and you should be able to see the new plugin in the sidebar.