1# Gorilla WebSocket
 2
 3[![GoDoc](https://godoc.org/github.com/gorilla/websocket?status.svg)](https://godoc.org/github.com/gorilla/websocket)
 4[![CircleCI](https://circleci.com/gh/gorilla/websocket.svg?style=svg)](https://circleci.com/gh/gorilla/websocket)
 5
 6Gorilla WebSocket is a [Go](http://golang.org/) implementation of the
 7[WebSocket](http://www.rfc-editor.org/rfc/rfc6455.txt) protocol.
 8
 9
10### Documentation
11
12* [API Reference](https://pkg.go.dev/github.com/gorilla/websocket?tab=doc)
13* [Chat example](https://github.com/gorilla/websocket/tree/master/examples/chat)
14* [Command example](https://github.com/gorilla/websocket/tree/master/examples/command)
15* [Client and server example](https://github.com/gorilla/websocket/tree/master/examples/echo)
16* [File watch example](https://github.com/gorilla/websocket/tree/master/examples/filewatch)
17
18### Status
19
20The Gorilla WebSocket package provides a complete and tested implementation of
21the [WebSocket](http://www.rfc-editor.org/rfc/rfc6455.txt) protocol. The
22package API is stable.
23
24### Installation
25
26    go get github.com/gorilla/websocket
27
28### Protocol Compliance
29
30The Gorilla WebSocket package passes the server tests in the [Autobahn Test
31Suite](https://github.com/crossbario/autobahn-testsuite) using the application in the [examples/autobahn
32subdirectory](https://github.com/gorilla/websocket/tree/master/examples/autobahn).
33