Merge pull request #106 from snail007/dev

docs
This commit is contained in:
snail007
2018-07-09 17:27:49 +08:00
committed by GitHub

View File

@ -12,18 +12,12 @@ Proxy is a high performance HTTP, HTTPS, HTTPS, websocket, TCP, UDP, Socks5 prox
**[全平台SDK](/sdk/README.md)**
### How to use the source code?
### How to contribute to the code (Pull Request)?
Pull Request is welcomed.
Recommend go1.10.1.
`go get github.com/snail007/goproxy`
use command cd to enter your go SRC directory
then cd to enter `github.com/snail007/goproxy`.
Direct compilation:`go build -o proxy`
execution: `go run *.go`
`utils` is a toolkit, and `service` is a specific service class.
First, you need to clone the project to your account, and then modify the code on the dev branch.
Finally, Pull Request to dev branch of goproxy project, and contribute code for efficiency.
PR needs to explain what changes have been made and why you change them.
### Features
- chain-style proxy: the program itself can be a primary proxy, and if a parent proxy is set, it can be used as a second level proxy or even a N level proxy.
@ -1080,10 +1074,15 @@ Then the local UDP port 53 provides a security and anti pollution DNS analysis.
- HTTP (s) proxy support PAC?
- Welcome joining group feedback...
### How to contribute to the code (Pull Request)?
First, you need to clone the project to your account, and then modify the code on the dev branch.
Finally, Pull Request to dev branch of goproxy project, and contribute code for efficiency.
PR needs to explain what changes have been made and why you change them.
### How to use the source code?
Recommend go1.10.1.
`go get github.com/snail007/goproxy`
use command cd to enter your go SRC directory
then cd to enter `github.com/snail007/goproxy`.
Direct compilation:`go build -o proxy`
execution: `go run *.go`
`utils` is a toolkit, and `service` is a specific service class.
### License
Proxy is licensed under GPLv3 license.