about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..890abcf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+# gProxy
+Simple multi-use TCP proxy written in golang.
+
+# Usage
+```
+./gProxy -r [remote ip] (-l [local ip]) (-d)
+```
+-r: remote ip for the proxy to connect to  
+-l: local ip for the proxy to listen at (Optional)  
+-d: enables debug info (Optional)