Browse Source

Update README.md

wangyu- 8 years ago
parent
commit
3ecf6625bb
2 changed files with 14 additions and 9 deletions
  1. 4 7
      README.md
  2. 10 2
      doc/README.zh-cn.md

+ 4 - 7
README.md

@@ -1,10 +1,10 @@
 # tinyFecVPN
 
-A tiny VPN with Build-in FEC Support.
+A Lightweight High-Performance VPN with Build-in Forward Error Correction Support.
 
 ![image](/images/tinyFecVPN.PNG)
 
-TinyFecVPN use same lib as UDPspeeder. Supports all FEC features of UDPspeeder. It can improve quality of all network traffic(TCP/UDP/ICMP) as a single program. TinyFecVPN works at VPN mode,while UDPspeeder works at UDP tunnel mode.
+TinyFecVPN Improves your Network Quality on a High-Latency Lossy Link by using Forward Error Correction. It uses same lib as UDPspeeder, supports all FEC features of UDPspeeder. TinyFecVPN works at VPN mode,while UDPspeeder works at UDP tunnel mode.
 
 [简体中文](/doc/README.zh-cn.md)(内容更丰富)
 
@@ -26,9 +26,6 @@ Linux host (including desktop Linux,<del>Android phone/tablet</del>, OpenWRT rou
 
 For Windows and MacOS You can run TinyFecVPN inside [this](https://github.com/wangyu-/udp2raw-tunnel/releases/download/20170918.0/lede-17.01.2-x86_virtual_machine_image_with_udp2raw_pre_installed.zip) 7.5mb virtual machine image.
 
-
-
-
 # How doest it work
 
 TinyFecVPN uses FEC(Forward Error Correction) to reduce packet loss rate, at the cost of addtional bandwidth. The algorithm for FEC is called Reed-Solomon.
@@ -51,7 +48,7 @@ Server side:
 iperf3 -s
 
 Client side:
-./tinyvpn_amd64 -c -r 45.76.100.53:5533 --mode 0
+./tinyvpn_amd64 -c -r 44.55.66.77:5533 --mode 0
 iperf3 -c 10.22.22.1 -P10
 ```
 
@@ -160,7 +157,7 @@ The last number of option should be zero, for exmaple 10.10.10.123 is invalild,
 
 Only works at client side.
 
-TinyFecVPN only handles one client at same time,the connection of a new client will kick old client,after being kicked,old client will just exit by default.
+TinyFecVPN server only handles one client at same time,the connection of a new client will kick old client,after being kicked,old client will just exit by default.
 
 If `--keep-reconnect` is enabled , the client will try to get connection back after being kicked.
 

+ 10 - 2
doc/README.zh-cn.md

@@ -67,7 +67,7 @@ https://github.com/wangyu-/tinyFecVPN/releases
 
 `-f20:10` 表示对每20个原始数据发送10个冗余包。`-f20:10` 和`-f 20:10`都是可以的,空格可以省略,对于所有的单字节option都是如此。对于双字节option,例如`--mode 0`和`--mtu 1200`,空格不可以省略。
 
-`-k` 指定一个字符串,server/client间所有收发的包都会被异或,改变协议特征,防止UDPspeeder的协议被运营商针对
+`-k` 开启简单的异或加密
 
 如果需要更省流量,或者更高吞吐率,请加上`--mode 0`。默认参数是`--mode 1`,倾向于更低的延迟。
 
@@ -141,6 +141,14 @@ https://github.com/wangyu-/UDPspeeder
 
 子网中的最后一个数字应该是0, 比如10.10.10.123是不符合规范的, 会被程序自动纠正成10.10.10.0.
 
+##### `--keep-reconnect`
+
+Only works at client side.
+
+TinyFecVPN server only handles one client at same time,the connection of a new client will kick old client,after being kicked,old client will just exit by default.
+
+If --keep-reconnect is enabled , the client will try to get connection back after being kicked.
+
 # 性能测试(侧重吞吐量)
 
 server 在 vulr 日本,CPU2.4GHz,内存 512mb。client 在搬瓦工美国,CPU 2.0GHZ,内存 96mb。在网路间额外模拟了10%的丢包,用于加重FEC的负担。
@@ -152,7 +160,7 @@ server 在 vulr 日本,CPU2.4GHz,内存 512mb。client 在搬瓦工美国,CP
 ./tinyvpn_amd64 -s -l 0.0.0.0:5533 --mode 0
 iperf3 -s
 在client端:
-./tinyvpn_amd64 -c -r 45.76.100.53:5533 --mode 0
+./tinyvpn_amd64 -c -r 44.55.66.77:5533 --mode 0
 iperf3 -c 10.22.22.1 -P10
 ```