From d1fa30924abf7ce5ee7311fcc9767b4d1bf44276 Mon Sep 17 00:00:00 2001
From: Yezzi Hsueh <xueye404@foxmail.com>
Date: Tue, 27 Feb 2024 23:31:17 +0800
Subject: [PATCH] docs: add readme

---
 .gitea/workflows/cron.yml |  4 +++-
 README.md                 | 21 +++++++++++++++++++++
 2 files changed, 24 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/.gitea/workflows/cron.yml b/.gitea/workflows/cron.yml
index bb698d8..a811edb 100644
--- a/.gitea/workflows/cron.yml
+++ b/.gitea/workflows/cron.yml
@@ -1,6 +1,8 @@
 name: Create Scripts
 on:
   push:
+    paths-ignore:
+      - "**.md"
   schedule:
     - cron: 0 5 * * *
 jobs:
@@ -21,4 +23,4 @@ jobs:
         uses: actions/upload-artifact@v3
         with:
           name: chn_list.rsc
-          path: chn_list.rsc
\ No newline at end of file
+          path: chn_list.rsc
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4bad433
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Mikrotik Router Switch
+
+For policy routing at china and foreign countries with Mikrotik RouterOS.
+
+## Quick Start
+
+Flush address list.
+
+```
+:foreach i in=[/ip firewall mangle find comment=\"breakwall\"] do={ /ip firewall mangle disable $i }
+:foreach i in=[ find list=$address_list ] do={ remove number=$i }
+```
+
+Upload chn_list.rsc script to your router, then run import command.
+
+```
+/import chn_list.rsc
+```
+
+> If there have any firewall rules that depends on the address list 'chn_list', for example mangle rules, disable
+> mangle rules before flush, and enable it after import.
\ No newline at end of file