From 05f63f8b5c1dae2b5ae3d0fed40fe7f67c08e572 Mon Sep 17 00:00:00 2001 From: Neale Pickett Date: Wed, 25 Jul 2018 00:01:53 +0000 Subject: [PATCH] Update README to refer to package documentation --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 68c2b03..8e9e117 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,14 @@ and room to grow these explorations into full-blown decoders. Get going ========= -Documentation sucks, sorry. -Start with `examples/simple` and build it up into whatever you want. +Package documentation at +https://godoc.org/github.com/dirtbags/netshovel + +We recommend you +copy `examples/simple/simple.go`, +change the `Simple` structs into your own protocol, +and build it up into whatever you want. + The Future