summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-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