From 918170d88c085ac9fdb607149b189ef8cbb6d0ff Mon Sep 17 00:00:00 2001
From: Bohdan Konkevych <bodya7979@hotmail.com>
Date: Tue, 15 Aug 2023 07:31:03 +0000
Subject: [PATCH] Add README.md

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dc1a432
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# TCP Proxy
+
+### Example usage:
+
+#### Add ability to connect to local ssh server from VPN network:
+```yml
+host_ssh:
+    build: https://git.devbones.com/conky/docker-tcp-proxy.git
+    network_mode: 'service:wireguard'
+    restart: unless-stopped
+    environment:
+      - PORT=22
+      - LISTEN_PORT=2222
+```
+
+#### Listed for connections on port 5353 and proxy them to CloudFlare DNS:
+```yml
+dns_proxy:
+    build: https://git.devbones.com/conky/docker-tcp-proxy.git
+    restart: unless-stopped
+    environment:
+      - PORT=53
+      - HOST=1.1.1.1
+      - LISTEN_PORT=5353
+```