Docs can be generated from the source with godoc

Bouke


On Tue, Nov 12, 2013 at 12:06 AM, Martin Kobetic
<notifications@github.com>wrote:

> In README.md:
>
> > @@ -1,4 +1,33 @@
> >  goreferrer
> >  ==========
> >
> > -A Go package that parses a referrer URL into types; search engine, social, direct, etc.
> > +A Go package that analyzes and classifies different kinds of referrer URLs (search, social, ...).
> > +
> > +## Example
> > +
> > +```
> > +	import ("github.com:Shopify/goreferrer")
>
> Thanks! I really need to actually run the example. I have a vague memory
> of reading something about automatic execution of examples somewhere in go,
> would be nice to integrate these into that if possible.
>
> —
> Reply to this email directly or view it on GitHub<https://github.com/Shopify/goreferrer/pull/2/files#r7577155>
> .
>