From 86f3f9af5263a1b1b8500c266ae13a7aec6a8192 Mon Sep 17 00:00:00 2001
From: GenZmeY <genzmey@gmail.com>
Date: Sun, 1 Aug 2021 02:51:21 +0300
Subject: [PATCH] Update readme

---
 README.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 58 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d66e7e4..1fca4fe 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,58 @@
-# KF2-AntiDDoS
\ No newline at end of file
+# KF2-AntiDDoS
+
+Compiled versions for windows and linux are available on the [releases page](https://github.com/GenZmeY/KF2-AntiDDoS/releases).  
+But you can build it yourself, for this there is a Makefile.
+
+## How it works
+The program parses the output of the KF2 server(s) and counts the number of connections. If the number of connections from one IP exceeds the threshold and it is still not known that this is a player, the program will execute a deny script passing it the IP as an argument.  
+The program will periodically execute the allow script, passing it a set of IPs blocked in the last period.
+
+## HowTo:
+Program usage and parameters [see here](https://github.com/GenZmeY/KF2-AntiDDoS/blob/master/doc/README)
+
+- Prepare an IP deny script for your firewall. The script must block the IP received by the first argument 
+- Prepare an IP set allow script for your firewall. The script must unblock the set of IPs given by the arguments 
+- Сreate a redirection of the output of all KF2 servers to the stdin of the program 
+- In the parameters specify the scripts that you prepared and the shell that will execute them 
+
+## Centos example 
+(change paths and values as you need) 
+### systemd service:
+```
+[Unit]
+Description=kf2-antiddos
+After=network-online.target
+Wants=network-online.target
+
+[Service]
+User=root
+Group=root
+Type=simple
+ExecStart=/bin/sh -c '/usr/bin/kf2-srv log tail | /usr/local/bin/kf2-antiddos-linux-amd64 /bin/bash /usr/local/share/kf2-antiddos/deny.sh /bin/bash /usr/local/share/kf2-antiddos/allow.sh'
+Restart=on-failure
+
+[Install]
+WantedBy=multi-user.target
+```
+### deny.sh
+```
+#!/bin/bash
+
+firewall-cmd --permanent --add-rich-rule="rule family=ipv4 source address=$1 port port=7777-7815 protocol=udp reject"
+firewall-cmd --reload
+```
+
+### allow.sh
+```
+#!/bin/bash
+
+for IP in $@
+do
+        firewall-cmd --permanent --remove-rich-rule="rule family=ipv4 source address=$IP port port=7777-7815 protocol=udp reject"
+done
+firewall-cmd --reload
+```
+
+## Contributing
+It would be great if someone set up and tried it on windows 
+