From ad5b3003b15060f5a2fe46bb8862ddd07ec72db1 Mon Sep 17 00:00:00 2001
From: Mmx233 <admin@mmxblog.com>
Date: Thu, 8 Dec 2022 19:32:05 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=20readme?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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

diff --git a/README.md b/README.md
index 125364d..1f1907e 100644
--- a/README.md
+++ b/README.md
@@ -54,12 +54,28 @@ settings:
       write_file: false #写日志文件
       log_path: ./ #日志文件存放目录路径
       log_name: "" #指定日志文件名
+  ddns: # 校园网内网 ip ddns
+    enable: false
+    domain: www.example.com
+    ttl: 600
+    provider: "" # dns provider 配置见 DDNS 说明
 ```
 
 登录参数从原网页登陆时对 `/srun_portal` 的请求抓取，抓取时请把浏览器控制台的 `preserve log`（保留日志）启用。
 
 运营商类型在原网页会被自动附加在账号后，请把 `@` 后面的部分填入 `user_type`，没有则留空（删掉默认的）
 
+## :bow_and_arrow: DDNS
+
+将 `ddns.enable` 设为 `true` 后，将在登录成功时设置指定域名的地址（ipv4，A 记录）
+
+支持的 Provider 及其设置：
+
+|  Provider  | 额外配置项                                   |
+|:----------:|-----------------------------------------|
+|   aliyun   | `access_key_id`<br/>`access_key_secret` |
+| cloudflare | `zone` 区域 ID<br/>`token` API 令牌         |
+
 ## :anchor: Docker / Kubernetes
 
 镜像：`mmx233/bitsrunlogin-go:latest`