Update docs

hwdsl2 · Jun 23, 2024 · 706483d · 706483d
1 parent bb9080c
commit 706483d
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 0 deletions.
diff --git a/docs/clients-zh.md b/docs/clients-zh.md
@@ -9,3 +9,27 @@
 要管理 WireGuard VPN 客户端，请再次运行安装脚本：`sudo bash wireguard.sh`。
 
 阅读 [:book: VPN book](https://ko-fi.com/post/Support-this-project-and-get-access-to-supporter-o-X8X5FVFZC) 以了解配置和管理 WireGuard VPN 客户端的分步说明。
+
+<details>
+<summary>
+查看 WireGuard 脚本的使用信息。
+</summary>
+
+```
+Usage: bash wireguard.sh [options]
+
+Options:
+  --auto                        auto install WireGuard using default options
+  --addclient [client name]     add a new client
+  --dns1 [DNS server IP]        primary DNS server for new client (optional, defaults to Google Public DNS)
+  --dns2 [DNS server IP]        secondary DNS server for new client (optional)
+  --listclients                 list the names of existing clients
+  --removeclient [client name]  remove an existing client
+  --showclientqr [client name]  show QR code for an existing client
+  --uninstall                   remove WireGuard and delete all configuration
+  -y, --yes                     assume "yes" as answer to prompts when removing a client or removing WireGuard
+  -h, --help                    show this help message and exit
+
+To customize install options, run this script without arguments.
+```
+</details>
diff --git a/docs/clients.md b/docs/clients.md
@@ -9,3 +9,27 @@ To add a VPN connection, open the WireGuard App on your mobile device, tap the "
 To manage WireGuard VPN clients, run the install script again: `sudo bash wireguard.sh`.
 
 Read [:book: VPN book](https://ko-fi.com/post/Support-this-project-and-get-access-to-supporter-o-O5O7FVF8J) to learn step-by-step instructions to configure and manage WireGuard VPN clients.
+
+<details>
+<summary>
+View usage information for the WireGuard script.
+</summary>
+
+```
+Usage: bash wireguard.sh [options]
+
+Options:
+  --auto                        auto install WireGuard using default options
+  --addclient [client name]     add a new client
+  --dns1 [DNS server IP]        primary DNS server for new client (optional, defaults to Google Public DNS)
+  --dns2 [DNS server IP]        secondary DNS server for new client (optional)
+  --listclients                 list the names of existing clients
+  --removeclient [client name]  remove an existing client
+  --showclientqr [client name]  show QR code for an existing client
+  --uninstall                   remove WireGuard and delete all configuration
+  -y, --yes                     assume "yes" as answer to prompts when removing a client or removing WireGuard
+  -h, --help                    show this help message and exit
+
+To customize install options, run this script without arguments.
+```
+</details>