update readme

This commit is contained in:
yggverse 2026-03-28 05:05:40 +02:00
parent e48bfff21d
commit 6cf4b86a90

View file

@ -13,10 +13,16 @@ Filtering asynchronous SOCKS5 (TCP/UDP) proxy server based on [fast-socks5](http
* [x] Web JSON/API
* [ ] Web UI
## Install
``` bash
cargo install psocks
```
## Usage
``` bash
RUST_LOG=trace cargo run -- -c=/path/to/config.toml no-auth
RUST_LOG=trace psokcs -c=/path/to/config.toml no-auth
```
* set `socks5://127.0.0.1:1080` proxy in your application
* use http://127.0.0.1:8010 for API:
@ -43,7 +49,7 @@ duckduckgo.com
### systemd
``` bash
git clone https://codeberg.org/postscriptum/psocks.git
git clone https://codeberg.org/yggverse/psocks.git
cd psocks
cargo build --release --locked
sudo install target/release/psocks /usr/local/bin