From 7f2bb614b3cefd23dcd93ed2b9e63328cef6c34f Mon Sep 17 00:00:00 2001 From: xdrm-brackets Date: Tue, 24 Apr 2018 17:25:52 +0200 Subject: [PATCH] [readme] first update --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index da2d27f..5c27a56 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,17 @@ -# gws +## GWS (Go WebSocket) -Go Websocket server/client implementation. - -Key objectives: fast, reliable, secure, rfc-full \ No newline at end of file +**author**: xdrm-brackets + +Websocket implementation in go. It features a server as well as a client. + + + +**Key objectives** + +| objective | my definition | +| :--------: | ------------------------------------------------------------ | +| fast | response time less than 1ms at least | +| reliable | gracefully handle usage/network/... errors | +| secure | add available cryptography (stream) | +| compatible | respect [RFC-6455](https://tools.ietf.org/html/rfc6455) as well as actual browser implementations | +| generic | use golang implicit interfaces to make the code reusable for all (most) cases |