Update README with installation instructions for Pipx and Poetry, and add usage examples for both modes.
This commit is contained in:
22
README.md
22
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 <server_hash>
|
||||
```
|
||||
|
||||
### Poetry
|
||||
|
||||
### Server Mode
|
||||
```bash
|
||||
# Basic server startup
|
||||
|
||||
Reference in New Issue
Block a user