Chore: update README.md

This commit is contained in:
gVisor bot 2019-12-08 12:34:05 +08:00
parent ecc943997d
commit 865fb297f3

View file

@ -6,6 +6,9 @@
<h4 align="center">A rule-based tunnel in Go.</h4> <h4 align="center">A rule-based tunnel in Go.</h4>
<p align="center"> <p align="center">
<a href="https://github.com/Dreamacro/clash/actions">
<img src="https://img.shields.io/github/workflow/status/Dreamacro/clash/Go?style=flat-square" alt="Github Actions">
</a>
<a href="https://goreportcard.com/report/github.com/Dreamacro/clash"> <a href="https://goreportcard.com/report/github.com/Dreamacro/clash">
<img src="https://goreportcard.com/badge/github.com/Dreamacro/clash?style=flat-square"> <img src="https://goreportcard.com/badge/github.com/Dreamacro/clash?style=flat-square">
</a> </a>
@ -17,7 +20,6 @@
## Features ## Features
- Local HTTP/HTTPS/SOCKS server - Local HTTP/HTTPS/SOCKS server
- Surge-like configuration format
- GeoIP rule support - GeoIP rule support
- Supports Vmess, Shadowsocks, Snell and SOCKS5 protocol - Supports Vmess, Shadowsocks, Snell and SOCKS5 protocol
- Supports Netfilter TCP redirecting - Supports Netfilter TCP redirecting
@ -70,7 +72,7 @@ $ clash -d .
``` ```
<details> <details>
<summary>This is an example configuration file</summary> <summary>This is an example configuration file (click to expand)</summary>
```yml ```yml
# port of HTTP # port of HTTP
@ -140,7 +142,6 @@ experimental:
# - 240.0.0.0/4 # - 240.0.0.0/4
Proxy: Proxy:
# shadowsocks # shadowsocks
# The supported ciphers(encrypt methods): # The supported ciphers(encrypt methods):
# aes-128-gcm aes-192-gcm aes-256-gcm # aes-128-gcm aes-192-gcm aes-256-gcm
@ -292,6 +293,9 @@ Rule:
``` ```
</details> </details>
## Advanced
[Provider](https://github.com/Dreamacro/clash/wiki/Provider)
## Documentations ## Documentations
https://clash.gitbook.io/ https://clash.gitbook.io/
@ -310,4 +314,5 @@ https://clash.gitbook.io/
- [x] Complementing the necessary rule operators - [x] Complementing the necessary rule operators
- [x] Redir proxy - [x] Redir proxy
- [x] UDP support - [x] UDP support
- [ ] Connection manager - [x] Connection manager
- [ ] Event API