Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Yuwei Ba <[email protected]>
  • Loading branch information
ibigbug authored Sep 20, 2023
1 parent 2d33b04 commit 3020124
Showing 1 changed file with 71 additions and 5 deletions.
76 changes: 71 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,60 @@
# clash-rs
Hello Clash
<p align="center">
<a href="https://ant.design">
<img width="200" src="https://github.com/Watfaq/clash-rs/assets/543405/76122ef1-eac8-478a-8ba4-ca5e54f8e272">
</a>
</p>

## Doc
<h1 align="center">ClashRS</h1>

https://watfaq.github.io/clash-rs/clash_doc/
<div align="center">

## 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)

</div>

## ✨ 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]
Expand All @@ -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)

0 comments on commit 3020124

Please sign in to comment.