git » 5medias » commit a05f290

Add a README file

author Alberto Bertogli
2018-06-09 09:18:21 UTC
committer Alberto Bertogli
2018-06-09 09:53:06 UTC
parent 8e4209b40b9d15f555bc40179b396a22e5a6f0d2

Add a README file

README.md +25 -0

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b2a248a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# 5medias
+
+[5medias] is a simple [SOCKS5] ([rfc]) proxy.
+
+It only supports TCP CONNECT commands, and static username/password
+authentication.
+
+This authentication is only useful to prevent the most basic unauthorized
+access, but it is not really secure and it's extremely easy to sniff. Don't
+rely on it for real security.
+
+## Install
+
+5medias is written in [Go], so to download and install the last version you
+can run:
+
+```sh
+go install blitiri.com.ar/go/5medias
+```
+
+
+[5medias]: https://blitiri.com.ar/git/r/5medias
+[SOCKS5]: https://en.wikipedia.org/wiki/SOCKS
+[rfc]: https://www.ietf.org/rfc/rfc1928.txt
+[Go]: https://golang.org