readme as reminder

2016-12-20 13:13:22 +03:00
parent 16a306080d
commit eedef48aa1
1 changed files with 9 additions and 1 deletions
--- a/README.md
+++ b/README.md
@@ -1 +1,9 @@
-# socks5-server
+# socks5-server
+Simple socks5 server using go-socks5 with hardcoded auth
+
+Run
+
+```docker build -t <image_name> .```
+
+Then
+```docker run -d -p 1080:1080 -e PROXY_USER=<PROXY_USER -e PROXY_PASSWORD=<PROXY_PASSWORD <image_name>```