From 1db1e4f4e99d349e918f6601dabe5e4e12d596cd Mon Sep 17 00:00:00 2001 From: clowwindy Date: Sun, 4 Jan 2015 23:22:26 +0800 Subject: [PATCH] Update README.md --- README.md | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index b10d9f7..511a29a 100644 --- a/README.md +++ b/README.md @@ -12,15 +12,6 @@ A fast tunnel proxy that helps you bypass firewalls. Install ------- -You'll have a client on your local side, and setup a server on a -remote server. - -### Client - -* [Windows] / [OS X] -* [Android] / [iOS] -* [OpenWRT] - ### Server #### Debian / Ubuntu: @@ -39,13 +30,14 @@ source list. #### Windows: -Install [OpenSSL for Windows]. Download [the package]. -Use `python shadowsocks/server.py` instead of `ssserver` command below. +1. Install [OpenSSL for Windows]. +2. Download [the package]. +3. Use `python shadowsocks/server.py` instead of `ssserver` command below. Usage ----- -On your server: +### Server ssserver -p 8000 -k password -m rc4-md5 @@ -54,10 +46,17 @@ To run in the background: ssserver -p 8000 -k password -m rc4-md5 -d start ssserver -p 8000 -k password -m rc4-md5 -d stop -On your client machine, use the same configuration as your server. Check the -README of your client for more information. +Check all the options via `-h`. You can also use a [Configuration] file +instead. + +### Client + +* [Windows] / [OS X] +* [Android] / [iOS] +* [OpenWRT] -Check the options via `-h`. You can also use a [Configuration] file instead. +Use GUI clients on your local PC/phones. Check the README of your client +for more information. Documentation -------------