update README

This commit is contained in:
Max Lv
2013-01-01 16:57:12 +08:00
parent 8edd8b4f45
commit 545be6d43d
+22 -9
View File
@@ -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).
Only the client is ported. Please use [shadowsocks-nodejs](https://github.com/clowwindy/shadowsocks-nodejs)
to setup your server.
installation
-----------
------------
Edit local.c, change server hostname.
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
```