diff --git a/README.md b/README.md index 3417e2c..9d72c46 100644 --- a/README.md +++ b/README.md @@ -38,20 +38,29 @@ configured to listen on a local UDP port and communicates with the upstream DNS ## CLI ``` -tun2proxy 0.1.0 Tunnel interface to proxy. -USAGE: - tun2proxy [OPTIONS] --tun +Usage: tun2proxy --tun --proxy --addr -FLAGS: - --help Prints help information - -V, --version Prints version information +Options: + -t, --tun + Name of the tun interface -OPTIONS: - -h, --http HTTP server to use - -s, --socks5 SOCKS5 server to use - -t, --tun Name of the tun interface + -p, --proxy + What proxy type to run + + Possible values: + - socks5: SOCKS5 server to use + - http: HTTP server to use + + -a, --addr + Server address with format IP:PORT + + -h, --help + Print help (see a summary with '-h') + + -V, --version + Print version ``` ## TODO