From 97ac3cac2f4931f529f14a3114bc91e285d62702 Mon Sep 17 00:00:00 2001
From: itdoginfo <koalav42@gmail.com>
Date: Wed, 19 Apr 2023 16:54:55 +0300
Subject: [PATCH] Add description for check-hirkn.sh

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/README.md b/README.md
index 53c3876..2c29c28 100644
--- a/README.md
+++ b/README.md
@@ -85,6 +85,36 @@ ansible-playbook playbooks/hirkn.yml
 
 После выполнения playbook роутер сразу начнёт выполнять обход блокировок через Wireguard сервер.
 
+# Скрипт для проверки конфигурации
+
+Написан для OpenWrt 22.03. На 21.02 работает только половина проверок.
+
+[x] - не обязательно означает, что эта часть не работает. Но это повод для ручной проверки.
+
+Есть функционал сохранения вывода скрипта, конфигурации сети и firewall в файл. Все чувствительные переменные при этом затираются.
+
+### Запуск
+```
+wget -O - https://raw.githubusercontent.com/itdoginfo/ansible-openwrt-hirkn/master/check-hirkn.sh | sh
+```
+
+### Запустить с созданием dump
+```
+wget -O - https://raw.githubusercontent.com/itdoginfo/ansible-openwrt-hirkn/master/check-hirkn.sh | sh -s dump
+```
+
+### Скачать и потом запустить
+```
+wget https://raw.githubusercontent.com/itdoginfo/ansible-openwrt-hirkn/master/check-hirkn.sh
+chmod +x check-hirkn.sh
+./check-hirkn.sh
+```
+
+С созданием dump
+```
+./check-hirkn.sh dump
+```
+
 # DNSCrypt-proxy2
 
 Если у вас уже стоит dnscrypt-proxy первой версии, его необходимо удалить