From 51004b14d98087392d4fa29084823128adeb7acc Mon Sep 17 00:00:00 2001
From: Larvan2 <78135608+Larvan2@users.noreply.github.com>
Date: Thu, 19 Oct 2023 23:41:43 +0800
Subject: [PATCH] docs: update readme.md

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

diff --git a/README.md b/README.md
index bbf5cf43..d5022dfb 100644
--- a/README.md
+++ b/README.md
@@ -21,7 +21,7 @@
 ## Features
 
 - Local HTTP/HTTPS/SOCKS server with authentication support
-- VMess, Shadowsocks, Trojan, Snell protocol support for remote connections
+- VMess, VLESS, Shadowsocks, Trojan, Snell, TUIC, Hysteria protocol support
 - Built-in DNS server that aims to minimize DNS pollution attack impact, supports DoH/DoT upstream and fake IP.
 - Rules based off domains, GEOIP, IPCIDR or Process to forward packets to different nodes
 - Remote groups allow users to implement powerful rules. Supports automatic fallback, load balancing or auto select node
@@ -32,259 +32,41 @@
 
 ## Dashboard
 
-We made an official web dashboard providing first class support for this project, check it out
-at [metacubexd](https://github.com/MetaCubeX/metacubexd)
+A web dashboard with first-class support for this project has been created; it can be checked out at [metacubexd](https://github.com/MetaCubeX/metacubexd).
 
-## Wiki
+## Configration example
 
-Configuration examples can be found
-at [/docs/config.yaml](https://github.com/MetaCubeX/Clash.Meta/blob/Alpha/docs/config.yaml), while documentation can be
-found [Clash.Meta Wiki](https://clash-meta.wiki).
+Configuration example is located at [/docs/config.yaml](https://github.com/MetaCubeX/Clash.Meta/blob/Alpha/docs/config.yaml).
 
-## Build
+## Docs
 
-You should install [golang](https://go.dev) first.
+Documentation can be found in [Clash.Meta Docs](https://clash-meta.wiki).
 
-Then get the source code of Clash.Meta:
+## For development
+
+Requirements:
+[Go 1.20 or newer](https://go.dev/dl/)
+
+Build Clash.Meta:
 
 ```shell
 git clone https://github.com/MetaCubeX/Clash.Meta.git
 cd Clash.Meta && go mod download
+go build
 ```
 
-If you can't visit GitHub, you should set proxy first:
+Set go proxy if a connection to GitHub is not possible:
 
 ```shell
 go env -w GOPROXY=https://goproxy.io,direct
 ```
 
-Now you can build it:
-
-```shell
-go build
-```
-
-If you need gvisor for tun stack, build with:
+Build with gvisor tun stack:
 
 ```shell
 go build -tags with_gvisor
 ```
 
-<!-- ## Advanced usage of this fork -->
-
-<!-- ### DNS configuration
-
-Support `geosite` with `fallback-filter`.
-
-Restore `Redir remote resolution`.
-
-Support resolve ip with a `Proxy Tunnel`.
-
-```yaml
-proxy-groups:
-  - name: DNS
-    type: url-test
-    use:
-      - HK
-    url: http://cp.cloudflare.com
-    interval: 180
-    lazy: true
-```
-
-```yaml
-dns:
-  enable: true
-  use-hosts: true
-  ipv6: false
-  enhanced-mode: redir-host
-  fake-ip-range: 198.18.0.1/16
-  listen: 127.0.0.1:6868
-  default-nameserver:
-    - 119.29.29.29
-    - 114.114.114.114
-  nameserver:
-    - https://doh.pub/dns-query
-    - tls://223.5.5.5:853
-  fallback:
-    - "https://1.0.0.1/dns-query#DNS" # append the proxy adapter name or group name to the end of DNS URL with '#' prefix.
-    - "tls://8.8.4.4:853#DNS"
-  fallback-filter:
-    geoip: false
-    geosite:
-      - gfw # `geosite` filter only use fallback server to resolve ip, prevent DNS leaks to unsafe DNS providers.
-    domain:
-      - +.example.com
-    ipcidr:
-      - 0.0.0.0/32
-```
-
-### TUN configuration
-
-Supports macOS, Linux and Windows.
-
-Built-in [Wintun](https://www.wintun.net) driver.
-
-```yaml
-# Enable the TUN listener
-tun:
-  enable: true
-  stack: system #   system/gvisor
-  dns-hijack:
-    - 0.0.0.0:53 # additional dns server listen on TUN
-  auto-route: true # auto set global route
-```
-
-### Rules configuration
-
-- Support rule `GEOSITE`.
-- Support rule-providers `RULE-SET`.
-- Support `multiport` condition for rule `SRC-PORT` and `DST-PORT`.
-- Support `network` condition for all rules.
-- Support source IPCIDR condition for all rules, just append to the end.
-- The `GEOSITE` databases via https://github.com/Loyalsoldier/v2ray-rules-dat.
-
-```yaml
-rules:
-  # network(tcp/udp) condition for all rules
-  - DOMAIN-SUFFIX,bilibili.com,DIRECT,tcp
-  - DOMAIN-SUFFIX,bilibili.com,REJECT,udp
-
-  # multiport condition for rules SRC-PORT and DST-PORT
-  - DST-PORT,123/136/137-139,DIRECT,udp
-
-  # rule GEOSITE
-  - GEOSITE,category-ads-all,REJECT
-  - GEOSITE,icloud@cn,DIRECT
-  - GEOSITE,apple@cn,DIRECT
-  - GEOSITE,apple-cn,DIRECT
-  - GEOSITE,microsoft@cn,DIRECT
-  - GEOSITE,facebook,PROXY
-  - GEOSITE,youtube,PROXY
-  - GEOSITE,geolocation-cn,DIRECT
-  - GEOSITE,geolocation-!cn,PROXY
-
-  # source IPCIDR condition for all rules in gateway proxy
-  #- GEOSITE,geolocation-!cn,REJECT,192.168.1.88/32,192.168.1.99/32
-
-  - GEOIP,telegram,PROXY,no-resolve
-  - GEOIP,private,DIRECT,no-resolve
-  - GEOIP,cn,DIRECT
-
-  - MATCH,PROXY
-```
-
-### Proxies configuration
-
-Active health detection `urltest / fallback` (based on tcp handshake, multiple failures within a limited time will actively trigger health detection to use the node)
-
-Support `Policy Group Filter`
-
-```yaml
-proxy-groups:
-  - name: 🚀 HK Group
-    type: select
-    use:
-      - ALL
-    filter: "HK"
-
-  - name: 🚀 US Group
-    type: select
-    use:
-      - ALL
-    filter: "US"
-
-proxy-providers:
-  ALL:
-    type: http
-    url: "xxxxx"
-    interval: 3600
-    path: "xxxxx"
-    health-check:
-      enable: true
-      interval: 600
-      url: http://www.gstatic.com/generate_204
-```
-
-Support outbound transport protocol `VLESS`.
-
-The XTLS support (TCP/UDP) transport by the XRAY-CORE.
-
-```yaml
-proxies:
-  - name: "vless"
-    type: vless
-    server: server
-    port: 443
-    uuid: uuid
-    servername: example.com # AKA SNI
-    # flow: xtls-rprx-direct # xtls-rprx-origin  # enable XTLS
-    # skip-cert-verify: true
-
-  - name: "vless-ws"
-    type: vless
-    server: server
-    port: 443
-    uuid: uuid
-    tls: true
-    udp: true
-    network: ws
-    servername: example.com # priority over wss host
-    # skip-cert-verify: true
-    ws-opts:
-      path: /path
-      headers: { Host: example.com, Edge: "12a00c4.fm.huawei.com:82897" }
-
-  - name: "vless-grpc"
-    type: vless
-    server: server
-    port: 443
-    uuid: uuid
-    tls: true
-    udp: true
-    network: grpc
-    servername: example.com # priority over wss host
-    # skip-cert-verify: true
-    grpc-opts:
-      grpc-service-name: grpcname
-```
-
-Support outbound transport protocol `Wireguard`
-
-```yaml
-proxies:
-  - name: "wg"
-    type: wireguard
-    server: 162.159.192.1
-    port: 2480
-    ip: 172.16.0.2
-    ipv6: fd01:5ca1:ab1e:80fa:ab85:6eea:213f:f4a5
-    private-key: eCtXsJZ27+4PbhDkHnB923tkUn2Gj59wZw5wFA75MnU=
-    public-key: Cr8hWlKvtDt7nrvf+f0brNQQzabAqrjfBvas9pmowjo=
-    udp: true
-```
-
-Support outbound transport protocol `Tuic`
-
-```yaml
-proxies:
-  - name: "tuic"
-    server: www.example.com
-    port: 10443
-    type: tuic
-    token: TOKEN
-    # ip: 127.0.0.1 # for overwriting the DNS lookup result of the server address set in option 'server'
-    # heartbeat-interval: 10000
-    # alpn: [h3]
-    # disable-sni: true
-    reduce-rtt: true
-    # request-timeout: 8000
-    udp-relay-mode: native # Available: "native", "quic". Default: "native"
-    # congestion-controller: bbr # Available: "cubic", "new_reno", "bbr". Default: "cubic"
-    # max-udp-relay-packet-size: 1500
-    # fast-open: true
-    # skip-cert-verify: true
-``` -->
-
 ### IPTABLES configuration
 
 Work on Linux OS which supported `iptables`
@@ -298,62 +80,9 @@ iptables:
   inbound-interface: eth0 # detect the inbound interface, default is 'lo'
 ```
 
-### General installation guide for Linux
-
-- Create user given name `clash-meta`
-
-- Download and decompress pre-built binaries from [releases](https://github.com/MetaCubeX/Clash.Meta/releases)
-
-- Rename executable file to `Clash-Meta` and move to `/usr/local/bin/`
-
-- Create folder `/etc/Clash-Meta/` as working directory
-
-Run Meta Kernel by user `clash-meta` as a daemon.
-
-Create the systemd configuration file at `/etc/systemd/system/Clash-Meta.service`:
-
-```
-[Unit]
-Description=Clash-Meta Daemon, Another Clash Kernel.
-After=network.target NetworkManager.service systemd-networkd.service iwd.service
-
-[Service]
-Type=simple
-User=clash-meta
-Group=clash-meta
-LimitNPROC=500
-LimitNOFILE=1000000
-CapabilityBoundingSet=CAP_NET_ADMIN CAP_NET_RAW CAP_NET_BIND_SERVICE
-AmbientCapabilities=CAP_NET_ADMIN CAP_NET_RAW CAP_NET_BIND_SERVICE
-Restart=always
-ExecStartPre=/usr/bin/sleep 1s
-ExecStart=/usr/local/bin/Clash-Meta -d /etc/Clash-Meta
-ExecReload=/bin/kill -HUP $MAINPID
-
-[Install]
-WantedBy=multi-user.target
-```
-
-Launch clash-meta daemon on system startup with:
-
-```shell
-$ systemctl enable Clash-Meta
-```
-
-Launch clash-meta daemon immediately with:
-
-```shell
-$ systemctl start Clash-Meta
-```
-
-## Development
-
-If you want to build an application that uses clash as a library, check out
-the [GitHub Wiki](https://github.com/Dreamacro/clash/wiki/use-clash-as-a-library)
-
 ## Debugging
 
-Check [wiki](https://github.com/MetaCubeX/Clash.Meta/wiki/How-to-use-debug-api) to get an instruction on using debug
+Check [wiki](https://wiki.metacubex.one/api/#debug) to get an instruction on using debug
 API.
 
 ## Credits