Updated Shadowsocks 使用说明 (markdown)

Shadowsocks-使用说明.md

@@ -2,12 +2,18 @@
 
 一个可穿透防火墙的轻量代理。
 
-安装方法
--------
+安装
+----
 
 你需要在本地装一个客户端，在远程服务器上搭一个服务端。
 
-对于客户端，选一个[图形界面版本]就行。对于服务端：
+### 客户端
+
+* [Windows] / [OS X]
+* [Android] / [iOS]
+* [OpenWRT]
+
+### 服务端
 
 #### Debian / Ubuntu:
 
@@ -20,18 +26,10 @@
     easy_install pip
     pip install shadowsocks
 
-#### OS X:
+服务器配置
+---------
 
-    brew install swig
-    git clone https://github.com/clowwindy/M2Crypto.git
-    cd M2Crypto
-    pip install .
-    pip install shadowsocks
-
-使用方法
--------
-
-创建一个配置文件 `/etc/shadowsocks.json` (或者放在别的目录下)。
+服务端安装好以后，创建一个配置文件 `/etc/shadowsocks.json` (或者放在别的目录下)。
 示例：
 
     {
@@ -50,7 +48,7 @@
 
 | 字段名         | 含义                                            |
 | ------------- | ----------------------------------------------- |
-| server        | 服务端监听的地址                                  |
+| server        | 服务端监听的地址，服务端可填写 0.0.0.0             |
 | server_port   | 服务端的端口                                     |
 | local_address | 本地端监听的地址                                  |
 | local_port    | 本地端的端口                                     |
@@ -60,12 +58,12 @@
 | fast_open     | 是否使用 [TCP_FASTOPEN], true / false            |
 | workers       | worker 数量，Unix/Linux 可用，如果不理解含义请不要改 |
 
-在服务器上运行 `ssserver -c /etc/shadowsocks.json`。如果要在后台运行，
-[请使用 supervisor].
+在服务器上运行 `ssserver -c /etc/shadowsocks.json` 即可。如果要在后台运行，
+请使用 [supervisor].
 
-在本地运行 `sslocal -c /etc/shadowsocks.json`。
+在本地，用图形客户端进行相应配置并运行客户端。
 
-把浏览器的代理设为：
+把浏览器的代理设为下列参数即可。
 
     协议: socks5
     地址: 127.0.0.1
@@ -82,6 +80,8 @@
     ssserver -p server_port -k password -m bf-cfb --workers 2
     ssserver -c /etc/shadowsocks/config.json
 
+用 `-h` 查看所有参数。
+
 Wiki
 ----
 
@@ -100,6 +100,11 @@ MIT
 [常见问题]
 
 
+[Windows]:        https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#windows
+[OS X]:           https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#os-x
+[Android]:        https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#android
+[iOS]:            https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#ios
+[OpenWRT]:        https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#openwrt
 [构建状态]:        https://img.shields.io/travis/clowwindy/shadowsocks/master.svg?style=flat
 [图形界面版本]:    https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients
 [Issue Tracker]:  https://github.com/clowwindy/shadowsocks/issues?state=open