Update README.md

README.md

@@ -9,8 +9,8 @@ Both TCP CONNECT and UDP ASSOCIATE are implemented.
 
 [中文说明][3]
 
-Usage
+Install
------------
+-------
 
 First, make sure you have Python 2.6 or 2.7.
 
@@ -19,17 +19,36 @@ First, make sure you have Python 2.6 or 2.7.
     
 Install Shadowsocks.
 
+#### Debian / Ubuntu:
+
+    apt-get install python-gevent python-m2crypto
+    pip install shadowsocks
+
+#### CentOS:
+
+    yum install m2crypto python-setuptools
+    easy_install pip
     pip install shadowsocks
 
-Create a file named `config.json`, with the following content.
+#### Windows / OS X:
+
+Choose a [GUI client][7]
+
+Usage
+-----
+
+Create a config file `/etc/shadowsocks.json` (or put it in other path).
+Example:
 
     {
         "server":"my_server_ip",
         "server_port":8388,
+        "local_address": "127.0.0.1",
         "local_port":1080,
-        "password":"barfoo!",
+        "password":"mypassword",
-        "timeout":600,
+        "timeout":300,
-        "method":"table"
+        "method":"aes-256-cfb",
+        "fast_open": false
     }
 
 Explanation of the fields:
@@ -44,10 +63,9 @@ Explanation of the fields:
 | method      | encryption method, "aes-256-cfb" is recommended |
 | fast_open   | use [TCP_FASTOPEN][2], true / false             |
 
-`cd` into the directory of `config.json`. Run `ssserver` on your server. To run it in the background, run
+Run `ssserver -c /etc/shadowsocks.json` on your server. To run it in the background, [use supervisor][8].
-`nohup ssserver > log &`.
 
-On your client machine, run `sslocal`.
+On your client machine, run `sslocal -c /etc/shadowsocks.json`.
 
 Change the proxy settings in your browser to
 
@@ -68,52 +86,10 @@ You can use args to override settings from `config.json`.
     ssserver -p server_port -k password -m bf-cfb
     ssserver -c /etc/shadowsocks/config.json
 
-Encryption
+Wiki
-------------
+----
-
-Default encryption method table, which is not secure, is not recommended. Please use "aes-256-cfb" or "bf-cfb". "rc4" is not secure, either, please don't use it.
-
-List of all encryption methods:
-
-- aes-128-cfb
-- aes-192-cfb
-- aes-256-cfb
-- bf-cfb
-- camellia-128-cfb
-- camellia-192-cfb
-- camellia-256-cfb
-- cast5-cfb
-- des-cfb
-- idea-cfb
-- rc2-cfb
-- rc4
-- seed-cfb
-- table
-
-**If you want to use encryption method other than "table", please install [M2Crypto][4].**
-
-Ubuntu:
-
-    apt-get install python-m2crypto
-
-Others:
-
-    apt-get install openssl-dev swig
-    pip install M2Crypto
-
-Please notice that some encryption methods are not available on some environments.
-
-Performance
-------------
-
-You may want to install gevent for better performance.
-
-    $ sudo apt-get install python-gevent
-
-Or:
 
-    $ sudo apt-get install libevent-dev python-pip
+https://github.com/clowwindy/shadowsocks/wiki
-    $ sudo pip install gevent
 
 License
 -------
@@ -134,3 +110,5 @@ Also see [troubleshooting][6]
 [4]: http://chandlerproject.org/Projects/MeTooCrypto
 [5]: https://github.com/clowwindy/shadowsocks/issues?state=open
 [6]: https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting
+[7]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients
+[8]: https://github.com/clowwindy/shadowsocks/wiki/Configure-Shadowsocks-with-Supervisor