update docs

txthinking · Jul 25, 2024 · dcff0bb · dcff0bb
1 parent a864a37
commit dcff0bb
Show file tree

Hide file tree

Showing 8 changed files with 724 additions and 285 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/build.sh b/docs/build.sh
@@ -10,12 +10,13 @@ echo '**❤️  [Shiliew - A network app designed for those who value their time
 
 cat getting-started.md >> ../readme.md
 cat gui.md >> ../readme.md
-cat resources.md >> ../readme.md
 
 echo '# CLI Documentation' >> ../readme.md
+echo 'Each subcommand has a `--example` parameter that can print the minimal example of usage' >> ../readme.md
 jb '$1`brook mdpage`.split("\n").filter(v=>!v.startsWith("[")).join("\n").replace("```\n```", "```\nbrook --help\n```").split("\n").forEach(v=> echo(v.startsWith("**") && !v.startsWith("**Usage") ? "- "+v : v))' >> ../readme.md
 
 cat example.md >> ../readme.md
+cat resources.md >> ../readme.md
 
 markdown ../readme.md ./index.html
 
diff --git a/docs/example.md b/docs/example.md
@@ -262,16 +262,4 @@ brook relay --from :9999 --to 1.2.3.4:9999
 brook socks5tohttp --socks5 127.0.0.1:1080 --listen 127.0.0.1:8010
 ```
 
-## brook pac creates pac server
-
-```
-brook pac --listen 127.0.0.1:8080 --proxy 'SOCKS5 127.0.0.1:1080; SOCKS 127.0.0.1:1080; DIRECT' --bypassDomainList ...
-```
-
-## brook pac creates pac file
-
-```
-brook pac --file proxy.pac --proxy 'SOCKS5 127.0.0.1:1080; SOCKS 127.0.0.1:1080; DIRECT' --bypassDomainList ...
-```
-
 ## There are countless examples; for more feature suggestions, it's best to look at the commands and parameters in the CLI documentation one by one, and blog, YouTube...
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -14,7 +14,7 @@ nami install brook
 brook server -l :9999 -p hello
 ```
 
-## GUI Client
+## Client
 
 | iOS | Android      | Mac    |Windows      |Linux        |OpenWrt      |
 | --- | --- | --- | --- | --- | --- |

diff --git a/docs/gui.md b/docs/gui.md
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/resources.md b/docs/resources.md
@@ -5,7 +5,7 @@
 | [nami](https://github.com/txthinking/nami) | A clean and tidy decentralized package manager |
 | [joker](https://github.com/txthinking/joker) | Joker can turn process into daemon. Zero-Configuration |
 | [nico](https://github.com/txthinking/nico) | Nico can work with brook wsserver together |
-| [zhen](https://github.com/txthinking/zhen) | zhen - process and cron manager |
+| [z](https://github.com/txthinking/z) | z - process manager |
 | [tun2brook](https://github.com/txthinking/tun2brook) | Proxy all traffic just one line command |
 | [mad](https://github.com/txthinking/mad) | Generate root CA and derivative certificate for any domains and any IPs |
 | [hancock](https://github.com/txthinking/hancock) | Manage multiple remote servers and execute commands remotely |

diff --git a/ping/ping.json b/ping/ping.json
@@ -1,7 +1,7 @@
 {
     "version": "20240606",
-    "text": "Refer to get Brook Plus for free",
-    "link": "https://www.txthinking.com/brook.html#referrals",
-    "text_zh": "邀请以免费获得 Brook Plus",
-    "link_zh": "https://www.txthinking.com/brook.html#referrals"
+    "text": "Brook Client Basic Knowledge",
+    "link": "https://www.txthinking.com/talks/articles/brook-en.article",
+    "text_zh": "Brook 客户端基础知识",
+    "link_zh": "https://www.txthinking.com/talks/articles/brook.article"
 }