From 118d2edf8d1a3d745cf68674038f641c877a5d98 Mon Sep 17 00:00:00 2001 From: Hobai Riku Date: Sun, 7 Jun 2020 22:52:08 +0800 Subject: [PATCH] update README.md --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4d0e1aa..fe1b7e9 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,19 @@ wsl2-auto-portProxy(wslpp) is a simple tool for proxying port of linux running i - [ ] web interface - [ ] UDP port support -## Install +## Build and install +####build wslpp.exe from source +```bash +make build +``` +the bin file will be store in dist/wslpp.exe + +#### or install with `go get` +```bash +go get https://github.com/HobaiRiku/wsl2-auto-portproxy +``` +and use `wsl2-auto-portproxy.exe` to start proxy ## How it works wslpp start an interval to get IP address of the nat interface and scan all ports listening at all network in the subsystem, then use golang's `net` to start proxy direct to ports. @@ -36,10 +47,6 @@ Example: * predefined: Define the custom port to proxy, "666:22" means `windows(666)->linux(22)`, if undefined, port in windows will follow the same of linux. Must be a string array in the sub field name `tcp`. * ignore: If defined, will ignore the port in linux. Must be a number array in the sub field name `tcp`. -## Build -```bash -make build -``` ## License MIT