udpate docs

xvzc · Aug 6, 2024 · 24c48c6 · 24c48c6
1 parent 92b4229
commit 24c48c6
Show file tree

Hide file tree

Showing 5 changed files with 86 additions and 78 deletions.
diff --git a/readme.md b/readme.md
@@ -41,15 +41,18 @@ curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bas
 
 
 ## Go
-You can also install SpoofDPI with **go install**
-`$ go install github.com/xvzc/SpoofDPI/cmd/spoof-dpi@latest`
-  > Remember that $GOPATH should be set in your $PATH
+You can also install SpoofDPI with `go install`
+```bash
+$ go install github.com/xvzc/SpoofDPI/cmd/spoof-dpi@latest
+```
 
 ## Git
 You can also build your own
-`$ git clone https://github.com/xvzc/SpoofDPI.git`
-`$ cd SpoofDPI`
-`$ go build ./cmd/...`
+```bash
+$ git clone https://github.com/xvzc/SpoofDPI.git
+$ cd SpoofDPI
+$ go build ./cmd/...
+```
 
 # Usage
 ```
@@ -63,20 +66,18 @@ Usage: spoof-dpi [options...]
   -dns-port int
         port number for dns (default 53)
   -enable-doh
-        enable 'dns over https'
+        enable 'dns-over-https'
   -no-banner
         disable banner
-  -pattern string
-        bypass DPI only on packets matching this regex pattern
+  -pattern value
+        bypass DPI only on packets matching this regex pattern; can be given multiple times
   -port int
         port (default 8080)
   -system-proxy
         enable system-wide proxy (default true)
   -timeout int
-        timeout in milliseconds. no timeout when not given
-  -url value
-        Bypass DPI only on this url, can be passed multiple times
-  -v    print spoof-dpi's version. this may contain some other relevant information
+        timeout in milliseconds; no timeout when not given
+  -v    print spoof-dpi's version; this may contain some other relevant information
   -window-size int
         chunk size, in number of bytes, for fragmented client hello,
         try lower values if the default value doesn't bypass the DPI;
@@ -87,11 +88,13 @@ Usage: spoof-dpi [options...]
   go to Settings > Extensions, and disable them.
 
 ### OSX
-Run `$ spoof-dpi` and it will automatically set your proxy
+Run `spoof-dpi` and it will automatically set your proxy
 
 ### Linux
-Run `$ spoof-dpi` and open your favorite browser with proxy option
-`google-chrome --proxy-server="http://127.0.0.1:8080"`
+Run `spoof-dpi` and open your favorite browser with proxy option
+```bash
+google-chrome --proxy-server="http://127.0.0.1:8080"
+```
 
 # How it works
 ### HTTP

diff --git a/readme_ja.md b/readme_ja.md
@@ -38,15 +38,18 @@ curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bas
 
 
 ## Go
-**go install**でインストールすることもできます  
-`$ go install github.com/xvzc/SpoofDPI/cmd/spoof-dpi@latest`  
-  > $GOPATHが$PATHに設定されていることを確認してください
+`go install` でインストールすることもできます  
+```bash
+$ go install github.com/xvzc/SpoofDPI/cmd/spoof-dpi@latest
+```
 
 ## Git
 自分でビルドすることもできます  
-`$ git clone https://github.com/xvzc/SpoofDPI.git`  
-`$ cd SpoofDPI`  
-`$ go build ./cmd/...`  
+```bash
+$ git clone https://github.com/xvzc/SpoofDPI.git
+$ cd SpoofDPI
+$ go build ./cmd/...
+```
 
 # 使用方法
 ```
@@ -60,20 +63,18 @@ Usage: spoof-dpi [options...]
   -dns-port int
         port number for dns (default 53)
   -enable-doh
-        enable 'dns over https'
+        enable 'dns-over-https'
   -no-banner
         disable banner
-  -pattern string
-        bypass DPI only on packets matching this regex pattern
+  -pattern value
+        bypass DPI only on packets matching this regex pattern; can be given multiple times
   -port int
         port (default 8080)
   -system-proxy
         enable system-wide proxy (default true)
   -timeout int
-        timeout in milliseconds. no timeout when not given
-  -url value
-        Bypass DPI only on this url, can be passed multiple times
-  -v    print spoof-dpi's version. this may contain some other relevant information
+        timeout in milliseconds; no timeout when not given
+  -v    print spoof-dpi's version; this may contain some other relevant information
   -window-size int
         chunk size, in number of bytes, for fragmented client hello,
         try lower values if the default value doesn't bypass the DPI;
@@ -84,11 +85,13 @@ Usage: spoof-dpi [options...]
   設定 > 拡張機能に移動して無効にしてください。
 
 ### OSX
-`$ spoof-dpi`を実行すると、自動的にプロキシが設定されます。
+`spoof-dpi`を実行すると、自動的にプロキシが設定されます。
 
 ### Linux
-`$ spoof-dpi`を実行し、プロキシオプションを使用してブラウザを開きます。  
-`google-chrome --proxy-server="http://127.0.0.1:8080"`
+`spoof-dpi`を実行し、プロキシオプションを使用してブラウザを開きます。  
+```bash
+google-chrome --proxy-server="http://127.0.0.1:8080"
+```
 
 # 仕組み
 ### HTTP

diff --git a/readme_ko.md b/readme_ko.md
@@ -38,9 +38,10 @@ curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bas
 
 
 ## Go
-**go install**로 설치하기
-`$ go install github.com/xvzc/SpoofDPI/cmd/spoof-dpi`  
-  > Remember that $GOPATH should be set in your $PATH
+`go install`로 설치하기
+```bash
+$ go install github.com/xvzc/SpoofDPI/cmd/spoof-dpi@latest
+```
 
 ## Git
 직접 빌드하기
@@ -60,20 +61,18 @@ Usage: spoof-dpi [options...]
   -dns-port int
         port number for dns (default 53)
   -enable-doh
-        enable 'dns over https'
+        enable 'dns-over-https'
   -no-banner
         disable banner
-  -pattern string
-        bypass DPI only on packets matching this regex pattern
+  -pattern value
+        bypass DPI only on packets matching this regex pattern; can be given multiple times
   -port int
         port (default 8080)
   -system-proxy
         enable system-wide proxy (default true)
   -timeout int
-        timeout in milliseconds. no timeout when not given
-  -url value
-        Bypass DPI only on this url, can be passed multiple times
-  -v    print spoof-dpi's version. this may contain some other relevant information
+        timeout in milliseconds; no timeout when not given
+  -v    print spoof-dpi's version; this may contain some other relevant information
   -window-size int
         chunk size, in number of bytes, for fragmented client hello,
         try lower values if the default value doesn't bypass the DPI;

diff --git a/readme_ru.md b/readme_ru.md
@@ -40,20 +40,22 @@ curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bas
 ```
 
 ## Go
-Вы также можете установить SpoofDPI с помощью **go install**
-`$ go install github.com/xvzc/SpoofDPI/cmd/spoof-dpi`
-  > Не забудьте, что $GOPATH должен быть установлен в Вашем $PATH
+Вы также можете установить SpoofDPI с помощью `go install`
+```bash
+$ go install github.com/xvzc/SpoofDPI/cmd/spoof-dpi@latest
+```
 
 ## Git
 Вы также можете собрать SpoofDPI
-
-`$ git clone https://github.com/xvzc/SpoofDPI.git`
-`$ cd SpoofDPI`
-`$ go build ./cmd/...`
+```bash
+$ git clone https://github.com/xvzc/SpoofDPI.git
+$ cd SpoofDPI
+$ go build ./cmd/...
+```
 
 # Использование
 ```
-Использование: spoof-dpi [опции...]
+Usage: spoof-dpi [опции...]
   -addr string
         listen address (default "127.0.0.1")
   -debug
@@ -63,20 +65,18 @@ curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bas
   -dns-port int
         port number for dns (default 53)
   -enable-doh
-        enable 'dns over https'
+        enable 'dns-over-https'
   -no-banner
         disable banner
-  -pattern string
-        bypass DPI only on packets matching this regex pattern
+  -pattern value
+        bypass DPI only on packets matching this regex pattern; can be given multiple times
   -port int
         port (default 8080)
   -system-proxy
         enable system-wide proxy (default true)
   -timeout int
-        timeout in milliseconds. no timeout when not given
-  -url value
-        Bypass DPI only on this url, can be passed multiple times
-  -v    print spoof-dpi's version. this may contain some other relevant information
+        timeout in milliseconds; no timeout when not given
+  -v    print spoof-dpi's version; this may contain some other relevant information
   -window-size int
         chunk size, in number of bytes, for fragmented client hello,
         try lower values if the default value doesn't bypass the DPI;
@@ -87,11 +87,13 @@ curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bas
   Chrome, зайдите в Настройки > Расширения и отключите их.
 
 ### OSX
-Пропишите `$ spoof-dpi` и прокси автоматически установится
+Пропишите `spoof-dpi` и прокси автоматически установится
 
 ### Linux
-Пропишите `$ spoof-dpi` и откройте Chrome с параметром прокси
-`google-chrome --proxy-server="http://127.0.0.1:8080"`
+Пропишите `spoof-dpi` и откройте Chrome с параметром прокси
+```bash
+google-chrome --proxy-server="http://127.0.0.1:8080"
+```
 
 # Как это работает
 ### HTTP

diff --git a/readme_zh-cn.md b/readme_zh-cn.md
@@ -42,16 +42,18 @@ curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bas
 ```
 
 ## Go
-也可以用 **go install** 安装
-
-`$ go install github.com/xvzc/SpoofDPI/cmd/spoof-dpi`
- > 记得确认 $GOPATH 在你的 $PATH 中
+也可以用 `go install` 安装
+```bash
+$ go install github.com/xvzc/SpoofDPI/cmd/spoof-dpi@latest
+```
 
 ## Git
 You can also build your own
-`$ git clone https://github.com/xvzc/SpoofDPI.git`
-`$ cd SpoofDPI`
-`$ go build ./cmd/...`
+```bash
+$ git clone https://github.com/xvzc/SpoofDPI.git
+$ cd SpoofDPI
+$ go build ./cmd/...
+```
 
 # 使用方法
 
@@ -66,20 +68,18 @@ Usage: spoof-dpi [options...]
   -dns-port int
         port number for dns (default 53)
   -enable-doh
-        enable 'dns over https'
+        enable 'dns-over-https'
   -no-banner
         disable banner
-  -pattern string
-        bypass DPI only on packets matching this regex pattern
+  -pattern value
+        bypass DPI only on packets matching this regex pattern; can be given multiple times
   -port int
         port (default 8080)
   -system-proxy
         enable system-wide proxy (default true)
   -timeout int
-        timeout in milliseconds. no timeout when not given
-  -url value
-        Bypass DPI only on this url, can be passed multiple times
-  -v    print spoof-dpi's version. this may contain some other relevant information
+        timeout in milliseconds; no timeout when not given
+  -v    print spoof-dpi's version; this may contain some other relevant information
   -window-size int
         chunk size, in number of bytes, for fragmented client hello,
         try lower values if the default value doesn't bypass the DPI;
@@ -90,12 +90,13 @@ Usage: spoof-dpi [options...]
 > 如果你在 Chrome 浏览器使用其他 VPN 扩展比如 Hotspot Shield 请去 设置 > 扩展程序禁用它们
 
 ### OSX
-运行 `$ spoof-dpi` ，然后它会自动设置自身为代理
+运行 `spoof-dpi` ，然后它会自动设置自身为代理
 
 ### Linux
-运行 `$ spoof-dpi` 然后加上代理参数运行你的浏览器
-
-`google-chrome --proxy-server="http://127.0.0.1:8080"`
+运行 `spoof-dpi` 然后加上代理参数运行你的浏览器
+```bash
+google-chrome --proxy-server="http://127.0.0.1:8080"
+```
 
 # 工作原理