Skip to content

Commit 3821939

Browse files
committed
Get CI passing
1 parent 9925b64 commit 3821939

File tree

2 files changed

+440
-418
lines changed

2 files changed

+440
-418
lines changed

README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ websocket is a minimal and idiomatic WebSocket library for Go.
88
## Install
99

1010
```bash
11-
go get nhooyr.io/websocket
11+
go get nhooyr.io/websocket@v1.0.0
1212
```
1313

1414
## Features
@@ -19,7 +19,7 @@ go get nhooyr.io/websocket
1919
- Thorough tests, fully passes the [autobahn-testsuite](https://github.com/crossbario/autobahn-testsuite)
2020
- Zero dependencies outside of the stdlib for the core library
2121
- JSON and ProtoBuf helpers in the wsjson and wspb subpackages
22-
- High performance, memory reuse by default
22+
- Highly optimized by default
2323
- Concurrent writes out of the box
2424

2525
## Roadmap
@@ -129,8 +129,9 @@ gorilla/websocket requires you to constantly read from the connection to respond
129129
even if you don't expect the peer to send any messages.
130130

131131
In terms of performance, the differences depend on your application code. nhooyr/websocket
132-
reuses buffers efficiently out of the box whereas gorilla/websocket does not. As mentioned
133-
above, it also supports concurrent writers out of the box.
132+
reuses buffers efficiently out of the box if you use the wsjson and wspb subpackages whereas
133+
gorilla/websocket does not. As mentioned above, nhooyr/websocket also supports concurrent
134+
writers out of the box.
134135

135136
The only performance con to nhooyr/websocket is that uses two extra goroutines. One for
136137
reading pings, pongs and close frames async to application code and another to support

0 commit comments

Comments
 (0)