Browse Source

Update README.md

wangyu- 8 years ago
parent
commit
359b989bd1
2 changed files with 27 additions and 22 deletions
  1. 26 22
      README.md
  2. 1 0
      doc/README.zh-cn.md

+ 26 - 22
README.md

@@ -36,27 +36,6 @@ For more details,check:
 
 
 https://github.com/wangyu-/UDPspeeder/
 https://github.com/wangyu-/UDPspeeder/
 
 
-# Performance Test(throughput)
-
-Server is Vulr VPS in japan,CPU: single core 2.4GHz,ram: 512mb. Client is Bandwagonhost VPS in USA,CPU: single core 2.0GHZ,ram: 96mb。
-
-### Test command
-
-```
-Server side:
-./tinyvpn_amd64 -s -l 0.0.0.0:5533 --mode 0
-iperf3 -s
-
-Client side:
-./tinyvpn_amd64 -c -r 44.55.66.77:5533 --mode 0
-iperf3 -c 10.22.22.1 -P10
-```
-
-### Test result
-
-![image](/images/performance2.PNG)
-
-
 # Getting Started
 # Getting Started
 
 
 ### Installing
 ### Installing
@@ -104,6 +83,8 @@ main options:
     --timeout             <number>        how long could a packet be held in queue before doing fec, unit: ms, default: 8ms
     --timeout             <number>        how long could a packet be held in queue before doing fec, unit: ms, default: 8ms
     --mode                <number>        fec-mode,available values: 0, 1; 0 cost less bandwidth, 1 cost less latency(default)
     --mode                <number>        fec-mode,available values: 0, 1; 0 cost less bandwidth, 1 cost less latency(default)
     --report              <number>        turn on send/recv report, and set a period for reporting, unit: s
     --report              <number>        turn on send/recv report, and set a period for reporting, unit: s
+    --re-connect                          re-connect after lost connection,only for client.
+
 advanced options:
 advanced options:
     --mtu                 <number>        mtu. for mode 0, the program will split packet to segment smaller than mtu_value.
     --mtu                 <number>        mtu. for mode 0, the program will split packet to segment smaller than mtu_value.
                                           for mode 1, no packet will be split, the program just check if the mtu is exceed.
                                           for mode 1, no packet will be split, the program just check if the mtu is exceed.
@@ -161,7 +142,30 @@ TinyFecVPN server only handles one client at same time,the connection of a new c
 
 
 If `--keep-reconnect` is enabled , the client will try to get connection back after being kicked.
 If `--keep-reconnect` is enabled , the client will try to get connection back after being kicked.
 
 
-### Restriction
+
+# Performance Test(throughput)
+
+Server is Vulr VPS in japan,CPU: single core 2.4GHz,ram: 512mb. Client is Bandwagonhost VPS in USA,CPU: single core 2.0GHZ,ram: 96mb。
+
+### Test command
+
+```
+Server side:
+./tinyvpn_amd64 -s -l 0.0.0.0:5533 --mode 0
+iperf3 -s
+
+Client side:
+./tinyvpn_amd64 -c -r 44.55.66.77:5533 --mode 0
+iperf3 -c 10.22.22.1 -P10
+```
+
+### Test result
+
+![image](/images/performance2.PNG)
+
+
+
+# Restriction
 
 
 There is currently an intended restriction at server side.You cant use tinyFecVPN to access a third server directly. So,as a connection speed-up tool,when used alone,it only allows you to speed-up your connection to your server.You cant use it to bypass network firewalls directly.
 There is currently an intended restriction at server side.You cant use tinyFecVPN to access a third server directly. So,as a connection speed-up tool,when used alone,it only allows you to speed-up your connection to your server.You cant use it to bypass network firewalls directly.
 
 

+ 1 - 0
doc/README.zh-cn.md

@@ -92,6 +92,7 @@ main options:
     --timeout             <number>        how long could a packet be held in queue before doing fec, unit: ms, default: 8ms
     --timeout             <number>        how long could a packet be held in queue before doing fec, unit: ms, default: 8ms
     --mode                <number>        fec-mode,available values: 0, 1; 0 cost less bandwidth, 1 cost less latency(default)
     --mode                <number>        fec-mode,available values: 0, 1; 0 cost less bandwidth, 1 cost less latency(default)
     --report              <number>        turn on send/recv report, and set a period for reporting, unit: s
     --report              <number>        turn on send/recv report, and set a period for reporting, unit: s
+    --re-connect                          re-connect after lost connection,only for client.
 advanced options:
 advanced options:
     --mtu                 <number>        mtu. for mode 0, the program will split packet to segment smaller than mtu_value.
     --mtu                 <number>        mtu. for mode 0, the program will split packet to segment smaller than mtu_value.
                                           for mode 1, no packet will be split, the program just check if the mtu is exceed.
                                           for mode 1, no packet will be split, the program just check if the mtu is exceed.