summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorfadhil riyanto <me@fadev.org>2024-10-09 11:21:01 +0700
committerfadhil riyanto <me@fadev.org>2024-10-09 11:21:01 +0700
commitad32540de31202349b9dffff9048ba276334cf8f (patch)
tree8c5e7880e9a62e3320f84259fd4fd060e57875b7
parentd87a475995f8cd6012ea5d3f9603224bdea686f6 (diff)
add readme
Signed-off-by: fadhil riyanto <me@fadev.org>
-rw-r--r--readme.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..dcd65e5
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,16 @@
+# TCP Forwarder
+is a SOCKS5 proxy server that support both IPV4 and IPV6 (domain support is in progress)
+
+# Installation & run
+```sh
+git clone https://github.com/fadhil-riyanto/tcp-forwarder.git
+cd tcp-forwarder
+mkdir build
+cd build
+cmake ..
+make -j4
+./tcpf --listen 8013 --addr 127.0.0.1
+```
+
+# License
+GPL-2.0 \ No newline at end of file