Add top-level package documentation

This commit is contained in:
James Mills 2016-09-14 14:43:54 +10:00
parent a5a853e26b
commit 58ccb9172e
No known key found for this signature in database
GPG Key ID: AC4C014F1440EBD6
1 changed files with 7 additions and 0 deletions

View File

@ -1,3 +1,10 @@
// gopher provides an implementation of the Gopher protocol (RFC 1436)
//
// Much of the API is similar in design to the net/http package of the
// standard library. To build custom Gopher servers implement handler
// functions or the `Handler{}` interface. Implementing a client is as
// simple as calling `gopher.Get(uri)` and passing in a `uri` such as
// `"gopher://gopher.floodgap.com/"`.
package gopher
import (