Skip to content

Commit 36b0fb5

Browse files
committed
Add package level godoc
Closes #42 Don't really feel the need to have more detailed docs here, will just be hard to maintain.
1 parent a3c894c commit 36b0fb5

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

doc.go

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,8 @@
22
//
33
// See https://tools.ietf.org/html/rfc6455
44
//
5-
// For now the docs are at https://github.com/nhooyr/websocket#websocket. I will move them here later.
5+
// The examples are the best way to understand how to correctly use the library.
6+
//
7+
// Please see https://nhooyr.io/websocket for detailed design docs and a comparison with existing
8+
// libraries.
69
package websocket

0 commit comments

Comments
 (0)