diff --git a/README.md b/README.md index 3dbd44141..ec402770b 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,60 @@ -# clash-rs -Hello Clash +

+ + + +

-## Doc +

ClashRS

-https://watfaq.github.io/clash-rs/clash_doc/ +
-## Usage +A custom protocol, rule based network proxy software. +[![CI](https://github.com/Watfaq/clash-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/Watfaq/clash-rs/actions/workflows/ci.yml) + +
+ +## ✨ Features + +- 🌈 Flexible traffic routing rules based off source/destination IP/Domain/GeoIP etc. +- 📦 Local anti spoofing DNS with support of UDP/TCP/DoH/DoT remote. +- 🛡 Run as a HTTP/Socks5 proxy, or utun device as a home network gateway. +- ⚙️ Shadowsocks/Trojan/Vmess outbound support with different underlying trasports. +- 🌍 Dynamic remote rule/proxy loader. + +## 🖥 Environment Support + +- Linux +- macOS + +## 📦 Install + +### Download Prebuilt Binary + +Can be found at https://github.com/Watfaq/clash-rs/releases + +### Local Build + +``` +$ bazel build //clash +``` + +## 🔨 Usage + +### Example Config + +sample.yaml: + +```yaml +port: 7890 +``` + +### Run +```shell +-> % ./target/debug/clash -c sample.yaml +``` + +### Help ```shell -> % ./target/debug/clash -h Usage: clash [OPTIONS] @@ -18,3 +66,21 @@ Options: -h, --help Print help -V, --version Print version ``` + +## 🔗 Links + +- [Documentation(Coming Soon)]() +- [Config Reference](https://watfaq.github.io/clash-rs/) +- [Roadmap](https://github.com/Watfaq/clash-rs/issues/59) + +## ⌨️ Development + +We use *bazel* as our build system, however *cargo* is also supported. + +## 🤝 Contributing + +[CONTRIBUTING.md](CONTRIBUTING.md) + +## ❤️ Inspired By +- [Dreamacro/clash](https://github.com/Dreamacro/clash) +- [eycorsican/leaf](https://github.com/eycorsican/leaf)