From 545be6d43d2719f83870984823ca7892828fb628 Mon Sep 17 00:00:00 2001 From: Max Lv Date: Tue, 1 Jan 2013 16:57:12 +0800 Subject: [PATCH] update README --- README.md | 31 ++++++++++++++++++++++--------- 1 file changed, 22 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 10031196..9cb9173d 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,33 @@ shadowsocks-libev -=========== +================= -shadowsocks-libev is a lightweight tunnel proxy which can help you get through - firewalls. It is a port of [shadowsocks](https://github.com/clowwindy/shadowsocks). +shadowsocks-libev is a lightweight obfuscated scoks5 proxy. -Currently not stable yet. - Please use [shadowsocks-nodejs](https://github.com/clowwindy/shadowsocks-nodejs). +It is a port of [shadowsocks](https://github.com/clowwindy/shadowsocks). -installation ------------ +Only the client is ported. Please use [shadowsocks-nodejs](https://github.com/clowwindy/shadowsocks-nodejs) +to setup your server. -Edit local.c, change server hostname. +installation +------------ -Install the following package: +Build the binary like this: +```bash sudo apt-get install build-essential autoconf libtool libev-dev libssl-dev + automake --add-missing autoreconf ./configure && make +``` + +usage +----- + +``` + usage: ss -s server_host -p server_port -l local_port + -k password [-m encrypt_method] [-f pid_file] + info: + -m: accept two encrypt methods, "table" or "rc4" + -f: run in backgroud, with a valid path to the pid_file +```