docs: add usage description

This commit is contained in:
Shengjing Zhu
2022-03-07 00:55:42 +08:00
parent 72493d4c3c
commit a85c08c1d3
2 changed files with 25 additions and 2 deletions

View File

@@ -1,3 +1,12 @@
# wghttp
Turn WireGuard to an HTTP & SOCKS5 proxy.
Turn WireGuard to an HTTP & SOCKS5 proxies.
The HTTP & SOCKS5 proxies are served on same port. It runs in userspace,
without requirement of WireGuard kernel module or TUN device.
In remote exit mode, the proxy is served on local network, and the traffic
from proxy server goes to WireGuard network.
In local exit mode, the proxy is served on WireGuard network, and the traffic
from WireGuard goes to local network.