Improve documentation

This commit is contained in:
Armon Dadgar
2014-03-07 16:50:31 -08:00
parent 4e433eb4da
commit 539ffadba7
2 changed files with 31 additions and 0 deletions

View File

@@ -8,8 +8,29 @@ instead of the load balancer.
This library provides both a net.Listener and net.Conn implementation that
can be used to handle situation in which you may be using the proxy protocol.
Only proxy protocol version 1, the human-readable form, is understood.
The only caveat is that we check for the "PROXY " prefix to determine if the protocol
is being used. If that string may occur as part of your input, then it is ambiguous
if the protocol is being used and you may have problems.
# Documentation
Full documentation can be found [here](http://godoc.org/github.com/armon/go-proxyproto).
# Examples
Using the library is very simple:
```
// Create a listener
list, err := net.Listen("tcp", "...")
// Wrap listener in a proxyproto listener
proxyList := &proxyproto.Listener{list}
conn, err :=proxyList.Accept()
...
```