From dce8735ee47bfa475e3b952c14e4ec840c6949e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ola=20Holmstr=C3=B6m?= Date: Thu, 14 May 2015 14:20:53 +0200 Subject: [PATCH] update readme --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b85b474..094889d 100644 --- a/README.md +++ b/README.md @@ -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. +[![Chat demo](https://cdn.rawgit.com/olahol/melody/master/examples/chat/demo.gif "Demo")](https://github.com/olahol/melody/tree/master/examples/chat) + ```go 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) - - -## [Api](https://godoc.org/github.com/olahol/melody) +### [Documentation](https://godoc.org/github.com/olahol/melody)