From 58ccb9172e322ce69a3c35603d027c101e9f7d8c Mon Sep 17 00:00:00 2001 From: James Mills Date: Wed, 14 Sep 2016 14:43:54 +1000 Subject: [PATCH] Add top-level package documentation --- gopher.go | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/gopher.go b/gopher.go index a666596..fae999a 100644 --- a/gopher.go +++ b/gopher.go @@ -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 (