diff --git a/README.md b/README.md index 634eb38..66b9eaf 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Gorilla WebSocket +# Gorilla WebSocket Gorilla WebSocket is a [Go](http://golang.org/) implementation of the [WebSocket](http://www.rfc-editor.org/rfc/rfc6455.txt) protocol. @@ -13,7 +13,7 @@ Gorilla WebSocket is a [Go](http://golang.org/) implementation of the 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. +package API is stable. ### Installation @@ -34,17 +34,19 @@ subdirectory](https://github.com/gorilla/websocket/tree/master/examples/autobahn go.net -Protocol supportRFC 6455RFC 6455 +Protocol supportRFC 6455RFC 6455, see notes Limit size of received messageYesNo Send pings and receive pongsYesNo Send close messageYesNo -Read message using io.ReaderYesNo, see note -Write message using io.WriteCloserYesNo, see note +Read message using io.ReaderYesNo, see notes +Write message using io.WriteCloserYesNo, see notes Encode, decode JSON messageYesYes -Note: The go.net io.Reader and io.Writer operate across WebSocket message -boundaries. Read returns when the input buffer is full or a message boundary is -encountered, Each call to Write sends a message. The Gorilla io.Reader and -io.WriteCloser operate on a single WebSocket message. +Notes: +- The go.net package does not handle fragmented messages. +- The go.net io.Reader and io.Writer operate across WebSocket frame boundaries. + Read returns when the input buffer is full or a frame boundary is + encountered, Each call to Write sends a single frame message. The Gorilla + io.Reader and io.WriteCloser operate on a single WebSocket message.