gopkg/melody
2
0
Fork 0
Code Pull Requests Activity

update readme

Browse Source
This commit is contained in:
Ola Holmström
2015-05-14 14:20:53 +02:00
parent d9b33667c9
commit dce8735ee4
1 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+11 -4
View File
@@ -5,6 +5,14 @@
> :notes: Simple websocket framework for Go > :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 ## Install
```bash ```bash
@@ -16,6 +24,8 @@ go get github.com/olahol/melody
[Simple broadcasting chat server](https://github.com/olahol/melody/tree/master/examples/chat), [Simple broadcasting chat server](https://github.com/olahol/melody/tree/master/examples/chat),
error handling left as en exercise for the developer. error handling left as en exercise for the developer.
[![Chat demo](https://cdn.rawgit.com/olahol/melody/master/examples/chat/demo.gif "Demo")](https://github.com/olahol/melody/tree/master/examples/chat)
```go ```go
package main package main
@@ -45,7 +55,4 @@ func main() {
} }
``` ```
[![Chat demo](https://cdn.rawgit.com/olahol/melody/master/examples/chat/demo.gif "Demo")](https://github.com/olahol/melody/tree/master/examples/chat) ### [Documentation](https://godoc.org/github.com/olahol/melody)
## [Api](https://godoc.org/github.com/olahol/melody)