From 6ecd96e5ac54e66253fad393990e5d7c66d1df52 Mon Sep 17 00:00:00 2001 From: Birkhoff Lee Date: Wed, 17 May 2023 21:07:23 +0800 Subject: [PATCH] Docs: fix logo url and update README (#2747) Signed-off-by: Birkhoff Lee --- README.md | 37 +++++++++++++++---------------------- docs/.vitepress/config.ts | 2 +- 2 files changed, 16 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 0f1a05d..437da24 100644 --- a/README.md +++ b/README.md @@ -23,35 +23,28 @@ ## Features -- Local HTTP/HTTPS/SOCKS server with authentication support -- Shadowsocks(R), VMess, Trojan, Snell, SOCKS5, HTTP(S) outbound support -- Built-in [fake-ip](https://www.rfc-editor.org/rfc/rfc3089) DNS server that aims to minimize DNS pollution attack impact. DoH/DoT upstream supported. -- Rules based off domains, GEOIP, IP-CIDR or process names to route packets to different destinations -- Proxy groups allow users to implement powerful rules. Supports automatic fallback, load balancing or auto select proxy based off latency -- Remote providers, allowing users to get proxy lists remotely instead of hardcoding in config -- Transparent proxy: Redirect TCP and TProxy TCP/UDP with automatic route table/rule management -- Hot-reload via the comprehensive HTTP RESTful API controller +This is a general overview of the features that comes with Clash. -## Premium +- 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 -Premium core is proprietary. You can find their release notes and pre-built binaries [here](https://github.com/Dreamacro/clash/releases/tag/premium). +*Some of the features may only be available in the [Premium core](https://dreamacro.github.io/clash/premium/introduction.html).* -- gvisor/system stack TUN device on macOS, Linux and Windows ([ref](https://github.com/Dreamacro/clash/wiki/Clash-Premium-Features#tun-device)) -- Policy routing with [Scripts](https://github.com/Dreamacro/clash/wiki/Clash-Premium-Features#script) -- Load your rules with [Rule Providers](https://github.com/Dreamacro/clash/wiki/Clash-Premium-Features#rule-providers) -- Monitor Clash usage with a built-in profiling engine. ([Dreamacro/clash-tracing](https://github.com/Dreamacro/clash-tracing)) +## Documentation -## Getting Started -Documentations are available at [GitHub Wiki](https://github.com/Dreamacro/clash/wiki). - -## Development -If you want to build a Go application that uses Clash as a library, check out the [GitHub Wiki](https://github.com/Dreamacro/clash/wiki/Using-Clash-in-your-Golang-program). +You can find the latest documentation at [https://dreamacro.github.io/clash/](https://dreamacro.github.io/clash/). ## Credits -* [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) +- [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) ## License diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index b90bd0b..f46b155 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -82,7 +82,7 @@ export default defineConfig({ text: 'Edit this page on GitHub' }, - logo: '/logo.png', + logo: '/clash/logo.png', // https://vitepress.dev/reference/default-theme-config nav: [