From 0ca9c270e946b3af4b99a12a3a5a8fc5a1af4e93 Mon Sep 17 00:00:00 2001 From: Max Lv Date: Fri, 1 Feb 2013 10:53:24 +0800 Subject: [PATCH] update README --- README.md | 31 +++++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index f5bdfed2..9f2e45d5 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,40 @@ shadowsocks-libev ================= -shadowsocks-libev is a lightweight obfuscated scoks5 proxy. +Intro +----- + +Shadowsocks-libev is a lightweight obfuscated scoks5 proxy for embedded devices +like routers and mobile phones. + +It is a port of [shadowsocks](https://github.com/clowwindy/shadowsocks) with +only client part ported. -It is a port of [shadowsocks](https://github.com/clowwindy/shadowsocks). +To setup your own server, please refer to +[shadowsocks ports](https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients) +for more information. -Only the client is ported. Please use [shadowsocks-nodejs](https://github.com/clowwindy/shadowsocks-nodejs) -to setup your server. +Features +-------- -installation +Shadowsocks-libev is writen in C and only depends on +[libev](http://software.schmorp.de/pkg/libev.html). When statically linked and +packaged for OpenWRT, the total binary size is 23KB. In normal usage, the memory +consumption is about 600KB and the CPU utilization is no more than 5%, which is tested +in a low-end router (Buffalo WHR-G300N V2 with a 400MHz MIPS CPU, 32MB memory +and 4MB flash). + +Installation ------------ Build the binary like this: ```bash - sudo apt-get install build-essential autoconf libtool libev-dev libssl-dev - + sudo apt-get install build-essential autoconf libtool libev-dev ./configure && make ``` -usage +Usage ----- ```