From 36b0fb55a997bea25d38ed7566b7e61d84453e37 Mon Sep 17 00:00:00 2001 From: Anmol Sethi <hi@nhooyr.io> Date: Sat, 20 Apr 2019 14:09:34 -0400 Subject: [PATCH] Add package level godoc Closes #42 Don't really feel the need to have more detailed docs here, will just be hard to maintain. --- doc.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc.go b/doc.go index 655d8ad..8f8697f 100644 --- a/doc.go +++ b/doc.go @@ -2,5 +2,8 @@ // // See https://tools.ietf.org/html/rfc6455 // -// For now the docs are at https://github.com/nhooyr/websocket#websocket. I will move them here later. +// The examples are the best way to understand how to correctly use the library. +// +// Please see https://nhooyr.io/websocket for detailed design docs and a comparison with existing +// libraries. package websocket -- GitLab