penguin/tinyproxy

An L4 proxy designed to act as a tiny transparent shim

commit 17a285a3c0e86e6db343b76085be9ee9acdbd06d

author斟酌 鵬兄 <tgckpg@gmail.com>
date2026-05-28T13:53:02Z
subjectUpdate README.md
commit 17a285a3c0e86e6db343b76085be9ee9acdbd06d
Author: 斟酌 鵬兄 <tgckpg@gmail.com>
Date:   2026-05-28T13:53:02Z

    Update README.md
---
 README.md | 28 ++++++----------------------
 1 file changed, 6 insertions(+), 22 deletions(-)

diff --git a/README.md b/README.md
index 374ad48..a3f93a1 100644
--- a/README.md
+++ b/README.md
@@ -14,34 +14,18 @@ An L4 proxy designed to act as a tiny transparent shim.
 Configuration is line-based:
 
 ```text
-LISTEN_HOST:LISTEN_PORT UPSTREAM_HOST:UPSTREAM_PORT PROTO [OPTIONS...]
+listen <listen-proto> <listen-endpoint> <backend-proto> <backend-endpoint> [options...]
 ```
 
-Example TCP route:
+Example routes:
 
 ```text
-127.0.0.1:31232 127.0.0.1:41232 tcp
+tinyproxy \
+    -L "tcp :31232 tcp 127.0.0.1:41232" \
+    -L "udp :31232 udp 127.0.0.1:41232"
 ```
 
-Example UDP route:
-
-```text
-127.0.0.1:31232 127.0.0.1:41232 udp
-```
-
-Example TCP route with Proxy Protocol v2:
-
-```text
-127.0.0.1:31232 127.0.0.1:41232 tcp proxy_v2
-```
-
-Example UDP route with Proxy Protocol v2:
-
-```text
-127.0.0.1:31232 127.0.0.1:41232 udp proxy_v2
-```
-
-Run with:
+Run with config file:
 
 ```sh
 tinyproxy -c tinyproxy.conf