source/shadowsocks-rust
1
0
Fork 0
mirror of https://github.com/shadowsocks/shadowsocks-rust.git synced 2026-02-09 01:59:16 +08:00
Code Issues Packages Projects Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
Y. T. Chung
2015-08-23 11:58:27 +08:00
parent 88bed8cff7
commit 8759c44822
1 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -1,12 +1,17 @@
# shadowsocks-rust
[![Build Status](https://travis-ci.org/zonyitoo/shadowsocks-rust.svg)](https://travis-ci.org/zonyitoo/shadowsocks-rust)
[![Build Status](https://img.shields.io/travis/zonyitoo/shadowsocks-rust.svg)](https://travis-ci.org/zonyitoo/shadowsocks-rust)
[![License](https://img.shields.io/github/license/zonyitoo/shadowsocks-rust.svg)](https://github.com/zonyitoo/shadowsocks-rust)
This is a port of [shadowsocks](https://github.com/clowwindy/shadowsocks).
shadowsocks is a fast tunnel proxy that helps you bypass firewalls.
shadowsocks is a fast tunnel proxy that helps you <del>bypass firewalls</del>.
It is unstable! If you encounter any problems, please open an issue.
> **THIS PROJECT IS <u>ONLY FOR</u> TESTING THE AVAILABILITY AND USABILITY OF MY COROUTINE SERVER PROJECT.**
> **IF YOU ARE INTERESTED, PLEASE REFER TO `coio-rs` and `simplesched` PROJECT**.
It is **unstable**! If you encounter any problems, please open an issue.
## Dependences
@@ -103,7 +108,7 @@ It supports the following features:
* Crypto algorithms defined in `Cargo.toml`
* **Load balancing**
Currently it uses [simplesched](https://github.com/zonyitoo/simplesched) as the backend support library and it does not support Windows, <del>LoL</del>.
Currently it uses [coio-rs](https://github.com/zonyitoo/coio-rs) as the backend support library and it does not support Windows, <del>LoL</del>.
## TODO