Quad4-Software/proxynet
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README with installation instructions for Pipx and Poetry, and add usage examples for both modes.

Browse Source
This commit is contained in:
ivan
2025-12-26 15:18:13 -06:00
parent 9a3f7d260c
commit 2edd2f657a
1 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -3,12 +3,34 @@
Proxy to route regular TCP/UDP traffic through Reticulum. Proxy to route regular TCP/UDP traffic through Reticulum.
## Installation ## Installation
### Pipx
```bash ```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 poetry install
``` ```
## Usage ## Usage
### Pipx
```bash
proxynet --server --identity my_server
proxynet --client --port 1080 --preferred <server_hash>
```
### Poetry
### Server Mode ### Server Mode
```bash ```bash
# Basic server startup # Basic server startup