zishuo/shield
1
0
Fork 0
mirror of https://github.com/ericyan/shield.git synced 2025-09-26 19:21:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Eric Yan
2017-06-15 22:23:51 +08:00
parent 822a8d6f7b
commit a63e7b6b0c
1 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -1,3 +1,13 @@
# Shield
Shield is a toolkit for building VPN tunnels.
Shield is a toolkit for building VPN tunnels in Go. It does not try to
be a full-blown VPN implementation; instead, it provides you with the
building blocks for rolling your own.
## Usage
[example.go] showcases how to use the toolkit to build an unencrypted
point-to-point tunnel. Full documentation is available at [GoDoc].
[example.go]: https://github.com/ericyan/shield/blob/master/example.go
[GoDoc]: http://godoc.org/github.com/ericyan/shield