update README

README.rst

@@ -5,24 +5,11 @@ shadowsocks
 
 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 <https://github.com/shadowsocks/shadowsocks/wiki/Ports-and-Clients#windows>`__
-   / `OS
-   X <https://github.com/shadowsocks/shadowsocks-iOS/wiki/Shadowsocks-for-OSX-Help>`__
--  `Android <https://github.com/shadowsocks/shadowsocks/wiki/Ports-and-Clients#android>`__
-   / `iOS <https://github.com/shadowsocks/shadowsocks-iOS/wiki/Help>`__
--  `OpenWRT <https://github.com/shadowsocks/shadowsocks/wiki/Ports-and-Clients#openwrt>`__
-
 Server
-~~~~~~
+------
+
+Install
+~~~~~~~
 
 Debian / Ubuntu:
 ^^^^^^^^^^^^^^^^
@@ -32,107 +19,56 @@ Debian / Ubuntu:
     apt-get install python-pip
     pip install shadowsocks
 
-Or simply ``apt-get install shadowsocks`` if you have `Debian
-sid <https://packages.debian.org/unstable/python/shadowsocks>`__ in your
-source list.
-
 CentOS:
 ^^^^^^^
 
 ::
 
-    yum install python-setuptools
+    yum install python-setuptools && easy_install pip
-    easy_install pip
     pip install shadowsocks
 
 Windows:
 ^^^^^^^^
 
-Download `OpenSSL for
+See `Install Server on
-Windows <http://slproweb.com/products/Win32OpenSSL.html>`__ and install.
+Windows <https://github.com/shadowsocks/shadowsocks/wiki/Install-Shadowsocks-Server-on-Windows>`__
-Then install shadowsocks via easy\_install and pip as Linux. If you
-don't know how to use them, you can directly download `the
-package <https://pypi.python.org/pypi/shadowsocks>`__, and use
-``python shadowsocks/server.py`` instead of ``ssserver`` command below.
-
-Configuration
--------------
 
-On your server create a config file ``/etc/shadowsocks.json``. Example:
+Usage
+~~~~~
 
 ::
 
-    {
+    ssserver -p 8000 -k password -m rc4-md5
-        "server":"my_server_ip",
-        "server_port":8388,
-        "local_address": "127.0.0.1",
-        "local_port":1080,
-        "password":"mypassword",
-        "timeout":300,
-        "method":"aes-256-cfb",
-        "fast_open": false
-    }
-
-Explanation of the fields:
-
-+------------------+-----------------------------------------------------------------------------------------------------------+
-| Name             | Explanation                                                                                               |
-+==================+===========================================================================================================+
-| server           | the address your server listens                                                                           |
-+------------------+-----------------------------------------------------------------------------------------------------------+
-| server\_port     | server port                                                                                               |
-+------------------+-----------------------------------------------------------------------------------------------------------+
-| local\_address   | the address your local listens                                                                            |
-+------------------+-----------------------------------------------------------------------------------------------------------+
-| local\_port      | local port                                                                                                |
-+------------------+-----------------------------------------------------------------------------------------------------------+
-| password         | password used for encryption                                                                              |
-+------------------+-----------------------------------------------------------------------------------------------------------+
-| timeout          | in seconds                                                                                                |
-+------------------+-----------------------------------------------------------------------------------------------------------+
-| method           | default: "aes-256-cfb", see `Encryption <https://github.com/shadowsocks/shadowsocks/wiki/Encryption>`__   |
-+------------------+-----------------------------------------------------------------------------------------------------------+
-| fast\_open       | use `TCP\_FASTOPEN <https://github.com/shadowsocks/shadowsocks/wiki/TCP-Fast-Open>`__, true / false       |
-+------------------+-----------------------------------------------------------------------------------------------------------+
-| workers          | number of workers, available on Unix/Linux                                                                |
-+------------------+-----------------------------------------------------------------------------------------------------------+
-
-On your server:
-
-To run in the foreground:
-
-::
-
-    ssserver -c /etc/shadowsocks.json
 
 To run in the background:
 
 ::
 
-    ssserver -c /etc/shadowsocks.json -d start
+    ssserver -p 8000 -k password -m rc4-md5 -d start
-    ssserver -c /etc/shadowsocks.json -d stop
+    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.
 
-Command Line Options
+Check all the options via ``-h``. You can also use a
---------------------
+`Configuration <https://github.com/shadowsocks/shadowsocks/wiki/Configuration-via-Config-File>`__
+file instead.
 
-Check the options via ``-h``.You can use args to override settings from
+Client
-``config.json``.
+------
 
-::
+-  `Windows <https://github.com/shadowsocks/shadowsocks/wiki/Ports-and-Clients#windows>`__
+   / `OS
+   X <https://github.com/shadowsocks/shadowsocks-iOS/wiki/Shadowsocks-for-OSX-Help>`__
+-  `Android <https://github.com/shadowsocks/shadowsocks/wiki/Ports-and-Clients#android>`__
+   / `iOS <https://github.com/shadowsocks/shadowsocks-iOS/wiki/Help>`__
+-  `OpenWRT <https://github.com/shadowsocks/openwrt-shadowsocks>`__
 
-    sslocal -s server_name -p server_port -l local_port -k password -m bf-cfb
+Use GUI clients on your local PC/phones. Check the README of your client
-    ssserver -p server_port -k password -m bf-cfb --workers 2
+for more information.
-    ssserver -c /etc/shadowsocks/config.json -d start --pid-file=/tmp/shadowsocks.pid
-    ssserver -c /etc/shadowsocks/config.json -d stop --pid-file=/tmp/shadowsocks.pid
 
 Documentation
 -------------
 
-You can find all the documentation in the wiki:
+You can find all the documentation in the
-https://github.com/shadowsocks/shadowsocks/wiki
+`Wiki <https://github.com/shadowsocks/shadowsocks/wiki>`__.
 
 License
 -------
@@ -145,7 +81,7 @@ Bugs and Issues
 -  `Troubleshooting <https://github.com/shadowsocks/shadowsocks/wiki/Troubleshooting>`__
 -  `Issue
    Tracker <https://github.com/shadowsocks/shadowsocks/issues?state=open>`__
--  `Mailing list <http://groups.google.com/group/shadowsocks>`__
+-  `Mailing list <https://groups.google.com/group/shadowsocks>`__
 
 .. |PyPI version| image:: https://img.shields.io/pypi/v/shadowsocks.svg?style=flat
    :target: https://pypi.python.org/pypi/shadowsocks