clash/README.md

54 lines
2.4 KiB
Markdown
Raw Normal View History

2018-06-23 00:44:28 +08:00
<h1 align="center">
<img src="https://github.com/Dreamacro/clash/raw/master/docs/logo.png" alt="Clash" width="200">
2019-02-11 15:55:17 +08:00
<br>Clash<br>
2018-06-23 00:44:28 +08:00
</h1>
<h4 align="center">A rule-based tunnel in Go.</h4>
2018-06-23 00:44:28 +08:00
<p align="center">
2019-12-08 12:34:05 +08:00
<a href="https://github.com/Dreamacro/clash/actions">
2022-12-22 12:09:24 +08:00
<img src="https://img.shields.io/github/actions/workflow/status/Dreamacro/clash/release.yml?branch=master&style=flat-square" alt="Github Actions">
2019-12-08 12:34:05 +08:00
</a>
2018-06-23 00:44:28 +08:00
<a href="https://goreportcard.com/report/github.com/Dreamacro/clash">
2019-02-11 15:55:17 +08:00
<img src="https://goreportcard.com/badge/github.com/Dreamacro/clash?style=flat-square">
2018-06-23 00:44:28 +08:00
</a>
2021-09-20 17:22:40 +08:00
<img src="https://img.shields.io/github/go-mod/go-version/Dreamacro/clash?style=flat-square">
2018-06-23 00:44:28 +08:00
<a href="https://github.com/Dreamacro/clash/releases">
<img src="https://img.shields.io/github/release/Dreamacro/clash/all.svg?style=flat-square">
</a>
2021-09-20 17:22:40 +08:00
<a href="https://github.com/Dreamacro/clash/releases/tag/premium">
<img src="https://img.shields.io/badge/release-Premium-00b4f0?style=flat-square">
</a>
2018-06-23 00:44:28 +08:00
</p>
2018-06-10 22:50:03 +08:00
## Features
This is a general overview of the features that comes with Clash.
2018-08-14 18:06:56 +08:00
- Inbound: HTTP, HTTPS, SOCKS5 server, TUN device
- Outbound: Shadowsocks(R), VMess, Trojan, Snell, SOCKS5, HTTP(S), Wireguard
- Rule-based Routing: dynamic scripting, domain, IP addresses, process name and more
- Fake-IP DNS: minimises impact on DNS pollution and improves network performance
- Transparent Proxy: Redirect TCP and TProxy TCP/UDP with automatic route table/rule management
- Proxy Groups: automatic fallback, load balancing or latency testing
- Remote Providers: load remote proxy lists dynamically
- RESTful API: update configuration in-place via a comprehensive API
2020-12-27 00:14:24 +08:00
*Some of the features may only be available in the [Premium core](https://dreamacro.github.io/clash/premium/introduction.html).*
2020-12-27 00:14:24 +08:00
## Documentation
You can find the latest documentation at [https://dreamacro.github.io/clash/](https://dreamacro.github.io/clash/).
## Credits
2018-08-12 04:22:14 +08:00
- [riobard/go-shadowsocks2](https://github.com/riobard/go-shadowsocks2)
- [v2ray/v2ray-core](https://github.com/v2ray/v2ray-core)
- [WireGuard/wireguard-go](https://github.com/WireGuard/wireguard-go)
2018-09-16 23:08:04 +08:00
## License
2018-08-12 04:22:14 +08:00
This software is released under the GPL-3.0 license.
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FDreamacro%2Fclash.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FDreamacro%2Fclash?ref=badge_large)