diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 22 |
1 files changed, 22 insertions, 0 deletions
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`. |