From 2219d4e32557a41bacadb04ce35e57fe067bf7f7 Mon Sep 17 00:00:00 2001 From: Ruben Pollan Date: Thu, 18 Jul 2019 13:19:27 +0200 Subject: [feat] first implementation of the library --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..ae9bf8f --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +ShapeShifter library +-------------------- + +Heavily based on the shapeshifter-dispatcher: +https://github.com/OperatorFoundation/shapeshifter-dispatcher/ + + +To use it: +```go + ss := ShapeShifter{ + Cert: "cert", + Target: "ip:port", + SocksAddr: "127.0.0.1:4430", + } + err := ss.Open() + if err != nil { + return err + } + defer ss.Close() +``` + +And now you can tunnel your protocol into `127.0.0.1:4430`. -- cgit v1.2.3