Skip to content

Commit 15f7e1f

Browse files
authored
README: Add godoc badge, links. (#21)
Most Go projects already have these, so it feels out of place not to have them here. They're helpful and give context.
1 parent f7ee9fa commit 15f7e1f

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

Diff for: README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
websocket
22
=========
33

4-
Packages websocket and websocketjs provide high- and low-level bindings for the browser's WebSocket API (respectively).
4+
[![GoDoc](https://godoc.org/github.com/gopherjs/websocket?status.svg)](https://godoc.org/github.com/gopherjs/websocket)
5+
6+
Packages [websocket](https://godoc.org/github.com/gopherjs/websocket) and [websocketjs](https://godoc.org/github.com/gopherjs/websocket/websocketjs) provide high- and low-level bindings for the browser's WebSocket API (respectively).
57

68
The high-level bindings offer a Dial function that returns a regular net.Conn.
79
It can be used similarly to net package.

0 commit comments

Comments
 (0)