README.md (1512B)
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 6 Gorilla WebSocket is a [Go](http://golang.org/) implementation of the 7 [WebSocket](http://www.rfc-editor.org/rfc/rfc6455.txt) protocol. 8 9 10 --- 11 12 ⚠️ **[The Gorilla WebSocket Package is looking for a new maintainer](https://github.com/gorilla/websocket/issues/370)** 13 14 --- 15 16 ### Documentation 17 18 * [API Reference](https://pkg.go.dev/github.com/gorilla/websocket?tab=doc) 19 * [Chat example](https://github.com/gorilla/websocket/tree/master/examples/chat) 20 * [Command example](https://github.com/gorilla/websocket/tree/master/examples/command) 21 * [Client and server example](https://github.com/gorilla/websocket/tree/master/examples/echo) 22 * [File watch example](https://github.com/gorilla/websocket/tree/master/examples/filewatch) 23 24 ### Status 25 26 The Gorilla WebSocket package provides a complete and tested implementation of 27 the [WebSocket](http://www.rfc-editor.org/rfc/rfc6455.txt) protocol. The 28 package API is stable. 29 30 ### Installation 31 32 go get github.com/gorilla/websocket 33 34 ### Protocol Compliance 35 36 The Gorilla WebSocket package passes the server tests in the [Autobahn Test 37 Suite](https://github.com/crossbario/autobahn-testsuite) using the application in the [examples/autobahn 38 subdirectory](https://github.com/gorilla/websocket/tree/master/examples/autobahn). 39