update readme
This commit is contained in:
@@ -5,6 +5,14 @@
|
||||
|
||||
> :notes: Simple websocket framework for Go
|
||||
|
||||
Melody is websocket framework based on [github.com/gorilla/websocket](https://github.com/gorilla/websocket)
|
||||
that abstracts away the more tedious parts of handling websockets. Features include:
|
||||
|
||||
* [x] Timeouts for write and read.
|
||||
* [x] Built-in ping/pong handling.
|
||||
* [x] Message buffer for connections making concurrent writing easy.
|
||||
* [x] Simple broadcasting to all or selected sessions.
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
@@ -16,6 +24,8 @@ go get github.com/olahol/melody
|
||||
[Simple broadcasting chat server](https://github.com/olahol/melody/tree/master/examples/chat),
|
||||
error handling left as en exercise for the developer.
|
||||
|
||||
[](https://github.com/olahol/melody/tree/master/examples/chat)
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
@@ -45,7 +55,4 @@ func main() {
|
||||
}
|
||||
```
|
||||
|
||||
[](https://github.com/olahol/melody/tree/master/examples/chat)
|
||||
|
||||
|
||||
## [Api](https://godoc.org/github.com/olahol/melody)
|
||||
### [Documentation](https://godoc.org/github.com/olahol/melody)
|
||||
|
||||
Reference in New Issue
Block a user