add README

This commit is contained in:
rui.zheng 2015-03-31 11:30:09 +08:00
parent c462a4df9d
commit df6abe8565
2 changed files with 61 additions and 0 deletions

22
LICENSE Normal file
View File

@ -0,0 +1,22 @@
The MIT License (MIT)
Copyright (c) 2014 郑锐
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

39
README.md Normal file
View File

@ -0,0 +1,39 @@
gost - GO Simple Tunnel
====
###GO语言实现的安全隧道
####特性
1. 支持标准socks5协议(rfc1928)。
2. 多种加密方式(tls, 以及aes-256-cfb, des-cfb rc4-md5等shadowsocks兼容的加密方式)。
3. 客户端兼容shadowsocks协议。
4. 支持设置上层http代理
####参数说明
> -L=":8080": listen address
> -P="": proxy for forward
> -S="": the server that connecting to
> -cert="cert.pem": cert.pem file for tls
> -key="key.pem": key.pem file for tls
> -m="tls": cipher method
> -p="ginuerzh@gmail.com": cipher password
> -sm="rc4-md5": shadowsocks cipher method
> -sp="ginuerzh@gmail.com": shadowsocks cipher password
> -ss=false: shadowsocks compatible
####使用方法
#####服务器端:
`$ gost -L=your_server_ip:443`
#####客户端:
`$ gost -L=:8080 -S=your_server_ip:443`