websocket/README.md

35 lines
1.4 KiB
Markdown
Raw Normal View History

# Gorilla WebSocket
2013-10-16 20:41:47 +04:00
[![GoDoc](https://godoc.org/github.com/gorilla/websocket?status.svg)](https://godoc.org/github.com/gorilla/websocket)
[![CircleCI](https://circleci.com/gh/gorilla/websocket.svg?style=svg)](https://circleci.com/gh/gorilla/websocket)
2013-10-29 17:29:20 +04:00
Gorilla WebSocket is a [Go](http://golang.org/) implementation of the
2013-10-16 20:41:47 +04:00
[WebSocket](http://www.rfc-editor.org/rfc/rfc6455.txt) protocol.
2013-10-29 17:29:20 +04:00
### Documentation
2013-10-16 20:41:47 +04:00
* [API Reference](https://pkg.go.dev/github.com/gorilla/websocket?tab=doc)
2013-10-16 20:41:47 +04:00
* [Chat example](https://github.com/gorilla/websocket/tree/master/examples/chat)
2015-10-18 23:32:14 +03:00
* [Command example](https://github.com/gorilla/websocket/tree/master/examples/command)
2015-09-24 01:23:26 +03:00
* [Client and server example](https://github.com/gorilla/websocket/tree/master/examples/echo)
2014-03-21 00:26:28 +04:00
* [File watch example](https://github.com/gorilla/websocket/tree/master/examples/filewatch)
* [Write buffer pool example](https://github.com/gorilla/websocket/tree/master/examples/bufferpool)
2013-10-16 20:41:47 +04:00
2013-10-29 17:29:20 +04:00
### Status
2013-10-16 20:41:47 +04:00
2013-10-29 17:29:20 +04:00
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.
2013-10-16 20:41:47 +04:00
2013-10-29 17:29:20 +04:00
### Installation
2013-10-16 20:41:47 +04:00
go get github.com/gorilla/websocket
2013-10-29 17:29:20 +04:00
### 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
2013-10-29 17:29:20 +04:00
subdirectory](https://github.com/gorilla/websocket/tree/master/examples/autobahn).