update README.md

linimbus · linimbus · commit 0789f7b68c21 · 2024-10-16T07:35:08.000Z
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+tcpproxy
diff --git a/README.md b/README.md
@@ -1 +1,27 @@
-# tcpproxy
+# tcpproxy
+
+## Function
+A simple tcpproxy proxy, a tcp transparent proxy that supports covert tls protocol <-> notls protocol.
+
+## Usage
+
+```
+./tcpproxy --help
+
+Usage of ./tcpproxy:
+  -help
+        this help
+  -local string
+        set local tcp protocol listen address. (default "0.0.0.0:8080")
+  -protocol string
+        set remote tcp protocol tcp or tcp6. (default "tcp")
+  -remote string
+        set remote tcp protocol proxy address.
+  -tls
+        enable remote tcp with tls encryption.
+```
+
+## Example
+```
+./tcpproxy -local 0.0.0.0:8080 -remote proxy.domain.com:8080 -protocol tcp6 -tls
+```
diff --git a/go.mod b/go.mod
@@ -0,0 +1,3 @@
+module github.com/easymesh/tcpproxy
+
+go 1.23.1

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module github.com/easymesh/tcpproxy`
	`2`	`+`
	`3`	`+go 1.23.1`