Skip to content

Commit c7ee8af

Browse files
committed
Add link to echo example in README.md
1 parent 60f2b1e commit c7ee8af

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ go get nhooyr.io/websocket
3434

3535
## Example
3636

37-
For a production quality example that shows off the full API, see the echo example on the godoc.
37+
For a production quality example that shows off the full API, see the [echo example on the godoc](https://godoc.org/nhooyr.io/websocket#example-package--Echo).
3838

3939
### Server
4040

@@ -82,12 +82,12 @@ if err != nil {
8282
// ...
8383
}
8484

85-
_, err = ww.Write([]byte("hi"))
85+
_, err = w.Write([]byte("hi"))
8686
if err != nil {
8787
// ...
8888
}
8989

90-
err = ww.Close()
90+
err = w.Close()
9191
if err != nil {
9292
// ...
9393
}

doc.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// See https://tools.ietf.org/html/rfc6455
44
//
5-
// The examples are the best way to understand how to correctly use the library.
5+
// The echo example is the best way to understand how to correctly use the library.
66
//
77
// Please see https://nhooyr.io/websocket for detailed design docs and a comparison with existing
88
// libraries.

0 commit comments

Comments
 (0)