From 15f9a1a62e37c7949484bb6785c48a8c2acd72d6 Mon Sep 17 00:00:00 2001
From: Dnomd343 <i@343.re>
Date: Sun, 19 Mar 2023 22:36:37 +0800
Subject: [PATCH] docs: add startup arguments description, ref #6

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

diff --git a/README.md b/README.md
index f25aba3..de632bd 100644
--- a/README.md
+++ b/README.md
@@ -66,6 +66,28 @@ ClearDNS 支持多种 DNS 协议，首先是常规 DNS ，即基于 UDP 或 TCP
 
 在 ClearDNS 的默认配置文件中，使用了本项目的分流资源作为更新上游，您可以修改配置，指向自定义资源（支持多个本地或远程文件），也可禁用更新。
 
+## 命令行参数
+
+在 ClearDNS 启动时，可以指定以下命令行参数：
+
++ `--config` ：指定配置文件名称，默认值为 `cleardns.yml`
+
++ `--verbose` ：打印完整的日志信息
+
++ `--debug` ：进入 Debug 模式
+
++ `--version` ：显示版本信息
+
++ `--help` ：显示帮助信息
+
+ClearDNS 也支持通过环境变量指定参数，其优先级低于命令行参数：
+
++ `CONFIG=my_config.yml` ：指定配置文件名称，默认值为 `cleardns.yml`
+
++ `VERBOSE=TRUE` ：打印完整的日志信息
+
++ `DEBUG=TRUE` ：进入 Debug 模式
+
 ## 配置格式
 
 ClearDNS 支持 JSON 、YAML 与 TOML 格式的配置文件，默认配置如下：