Improve: Add ReadMe

This commit is contained in:
陈奕程 2018-06-14 17:38:27 +08:00 committed by GitHub
parent 302b683c36
commit 6ff36e0887
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

39
README.md Normal file
View File

@ -0,0 +1,39 @@
# ClashX
A rule based proxy For Mac base on [clash](https://github.com/Dreamacro/clash).
#Features
HTTP/HTTPS and SOCKS proxy
Surge like configuration
GeoIP rule support
# Install
You can download from release page
# Config
You can use config generator in Status Bar Menu "Config" section.
Config support most of surge rules.
Configuration file at $HOME/.config/clash/config.ini
Below is a simple demo configuration file:
```
[General]
port = 7890
socks-port = 7891
[Proxy]
# name = ss, server, port, cipter, password
Proxy = ss, server, port, AEAD_CHACHA20_POLY1305, password
[Rule]
DOMAIN-SUFFIX,google.com,Proxy
DOMAIN-KEYWORD,google,Proxy
DOMAIN-SUFFIX,ad.com,REJECT
GEOIP,CN,DIRECT
FINAL,,Proxy // notice there is two ","
```