bump version 0.1.5

Author: optman

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "minivtun-rs"
-version = "0.1.4"
+version = "0.1.5"
 authors = ["optman <optman@gmail.com>"]
 edition = "2018"
 

README.md

@@ -1,33 +1,71 @@
 # minivtun-rs
-A Rust implementation of [minivtun](https://github.com/rssnsj/minivtun).
+A Rust implementation of [minivtun](https://github.com/rssnsj/minivtun),  with hole punching supported by [rndz](https://github.com/optman/rndz).
 
 ### Usage
 ```
-minivtun-rs 0.1
+minivtun-rs 0.1.5
 Mini virtual tunneller in non-standard protocol
 
 USAGE:
     minivtun-rs [FLAGS] [OPTIONS]
 
 FLAGS:
-    -d, --daemon     run as daemon process
-    -h, --help       Prints help information
-    -V, --version    Prints version information
+    -d, --daemon      run as daemon process
+    -h, --help        Prints help information
+    -i, --info        view current tunnel inf
+        --rebind      rebind socket before reconnect
+    -V, --version     Prints version information
+    -w, --wait-dns    wait for DNS resolve ready after service started
 
 OPTIONS:
-    -F, --fwmark <fwmark_num>              fwmark set on vpn traffic
-    -n, --ifname <ifname>                  virtual interface name
-    -a, --ipv4-addr <tun_lip/prf_len>      pointopoint IPv4 pair of the virtual interface
+        --client-timeo <N>                   maximum inactive time (seconds) before client timeout [default: 120]
+    -F, --fwmark <fwmark_num>                fwmark set on vpn traffic
+    -n, --ifname <ifname>                    virtual interface name
+    -a, --ipv4-addr <tun_lip/prf_len>        pointopoint IPv4 pair of the virtual interface
     -A, --ipv6-addr <tun_ip6/pfx_len>
-    -K, --keepalive <N>                    seconds between keep-alive tests, default:7
-    -e, --key <encryption_key>             shared password for data encryption
-    -l, --local <ip:port>                  local IP:port for server to listen
-    -M, --metric <metric>                  metric of attached routes
-    -m, --mtu <mtu>                        set MTU size, default:1300
-    -R, --reconnect-timeo <N>              maximum inactive time (seconds) before reconnect, default:47
-    -r, --remote <host:port>               host:port of server to connect (brace with [] for bare IPv6)
-    -v, --route <network/prefix[=gw>...    attached IPv4/IPv6 route on this link, can be multiple
-    -T, --table <table_name>               route table of the attached routes
-    -t, --type <encryption_type>           encryption type(aes-128, aes-256), default:aes-128
+    -K, --keepalive <N>                      seconds between keep-alive tests [default: 7]
+    -e, --key <encryption_key>               shared password for data encryption
+    -l, --local <ip:port>                    local IP:port for server to listen
+    -M, --metric <metric>                    metric of attached routes
+    -m, --mtu <mtu>                          mtu size [default: 1300]
+    -R, --reconnect-timeo <N>                maximum inactive time (seconds) before reconnect [default: 47]
+    -r, --remote <host:port>                 host:port of server to connect (brace with [] for bare IPv6)
+        --rndz-local-id <rndz_local_id>      rndz local id
+        --rndz-remote-id <rndz_remote_id>    rndz remote id
+        --rndz-server <rndz_server>          rndz server address
+    -v, --route <network/prefix[=gw>...      attached IPv4/IPv6 route on this link, can be multiple
+    -T, --table <table_name>                 route table of the attached routes
+    -t, --type <encryption_type>             encryption type [default: aes-128]  [possible values: plain, aes-128, aes-
+                                             256]
+
+```
+#### quick start
+
+server
+```
+minivtun-rs -l 0.0.0.0:1234 -a 10.0.0.1/24 -e helloworld
+```
+
+client
+```
+minivtun-rs -r {SERVERADDR}:1234 -a 10.0.0.2/24 -e helloworld
+```
+
+view status
 ```
+minivtun-rs -i
+```
+
+#### hole punching setup example
+
+server
+```
+minivtun-rs --rndz_server rndz.optman.net:8888 --rndz-local-id {SERVERNAME}  -a 10.0.0.1/24 -e helloworld
+```
+
+client
+```
+minivtun-rs --rndz_server rndz.optman.net:8888 --rndz-remote-id {SERVERNAME} --rndz-local-id {LOCALNAME} -a 10.0.0.2/24 -e helloworld
+```
+