diff --git a/README.md b/README.md index 07e747f..a3853db 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,34 @@ Proxy to route regular TCP/UDP traffic through Reticulum. ## Installation + +### Pipx + ```bash +pipx install git+https://git.quad4.io/Quad4-Software/proxynet.git +``` + +### Poetry + +Requires: Poetry, Git, Python 3.9+ + +```bash +git clone https://git.quad4.io/Quad4-Software/proxynet.git +cd proxynet poetry install ``` ## Usage +### Pipx + +```bash +proxynet --server --identity my_server +proxynet --client --port 1080 --preferred +``` + +### Poetry + ### Server Mode ```bash # Basic server startup