websocket/README.md

# Gorilla WebSocket

[![GoDoc](https://godoc.org/git.internal/re/websocket?status.svg)](https://godoc.org/git.internal/re/websocket)
[![CircleCI](https://circleci.com/gh/gorilla/websocket.svg?style=svg)](https://circleci.com/gh/gorilla/websocket)

Gorilla WebSocket is a [Go](http://golang.org/) implementation of the
[WebSocket](http://www.rfc-editor.org/rfc/rfc6455.txt) protocol.

---

**The Gorilla project has been archived, and is no longer under active maintainenance. You can read more here: https://github.com/gorilla#gorilla-toolkit**

---

### Documentation

* [API Reference](https://pkg.go.dev/git.internal/re/websocket?tab=doc)
* [Chat example](https://git.internal/re/websocket/tree/master/examples/chat)
* [Command example](https://git.internal/re/websocket/tree/master/examples/command)
* [Client and server example](https://git.internal/re/websocket/tree/master/examples/echo)
* [File watch example](https://git.internal/re/websocket/tree/master/examples/filewatch)

### Status

The Gorilla WebSocket package provides a complete and tested implementation of
the [WebSocket](http://www.rfc-editor.org/rfc/rfc6455.txt) protocol. The
package API is stable.

### Installation

    go get git.internal/re/websocket

### Protocol Compliance

The Gorilla WebSocket package passes the server tests in the [Autobahn Test
Suite](https://github.com/crossbario/autobahn-testsuite) using the application in the [examples/autobahn
subdirectory](https://git.internal/re/websocket/tree/master/examples/autobahn).