update readme

icewoods · Mar 10, 2016 · bf39fb3 · bf39fb3
1 parent d9961be
commit bf39fb3
Showing 1 changed file with 44 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,12 +1,50 @@
-# finalspeed
-
+# FinalSpeed
 FinalSpeed是高速双边加速软件,可加速所有基于tcp协议的网络服务,在高丢包和高延迟环境下,仍可达到90%的物理带宽利用率,即使高峰时段也能轻松跑满带宽.
 
-项目运行需要安装libpcap,windows下为winpcap.
+### 安装教程
+[客户端安装说明](http://www.d1sm.net/thread-7-1-1.html)
+<br />
+[服务端安装说明](http://www.d1sm.net/thread-8-1-1.html)
 
-客户端启动类: net.fs.client.FSClient
+<br>
 
-服务端启动类: net.fs.server.FSServer
+配置文件与finalspeed必须处在同一目录下.
+clien_config.json
+```
+{
+    // 下载速度，单位是 B，字节。这里换算起来就是 11MB。请把这里改成本机的下载速度
+    "download_speed": 11200698, 
+    // 协议：tcp 或 udp。注意：服务端如果是 OpenVZ 架构的话，则只支持 udp。
+    "protocal": "udp", 
+    // 服务器地址
+    "server_address": "1.2.3.4", 
+    // 一般不需要更改，保持默认即可。
+    "server_port": 150, 
+    // 不需要更改，保持默认即可。
+    "socks5_port": 1083, 
+    // 上传速度，单位是 B，字节。
+    "upload_speed": 357469
+}
+```
+port_map.json
+```
+{
+    "map_list": [
+        {
+            // 要加速的服务器端口
+            "dst_port": 12345, 
+            // 本地端口
+            "listen_port": 1099, 
+            // 备注信息
+            "name": "ss"
+        }, 
+        {
+            "dst_port": 23456, 
+            "listen_port": 2200, 
+            "name": "ssh"
+        }
+    ]
+}
+```
 
 论坛 http://www.d1sm.net/forum-44-1.html
-