Merge remote-tracking branch 'origin/stable' into dev

[contrib/qtwebsockets.git] / README.md

diff --git a/README.md b/README.md
index 3eb3834..b164a22 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,37 @@
-QWebSockets
-===========
+### Introduction
+`QtWebSockets` is a pure Qt implementation of WebSockets - both client and server.
+It is implemented as a Qt add-on module, that can easily be embedded into existing Qt projects. It has no other dependencies than Qt.
 
-Pure Qt implementation of WebSockets -both client and server
+### Features
+* Client and server capable
+* Text and binary sockets
+* Frame-based and message-based signals
+* Strict Unicode checking
+* WSS and proxy support
+
+### Requirements
+Qt 5.x
+
+### Build And Usage
+Checkout the source code from gitorious
+Go into the source directory and execute:
+
+    qmake
+    make
+    make install
+
+
+The last command will install `QtWebSockets` as a Qt module.
+
+To use, add `websockets` to the QT variable.
+
+`QT += websockets`
+
+### Compliance
+`QtWebSockets` is compliant with [RFC6455](http://datatracker.ietf.org/doc/rfc6455/?include_text=1) and has been tested with the [Autobahn Testsuite](http://autobahn.ws/testsuite).
+
+### Missing Features
+* Extensions and sub-protocols
+
+### License
+This code is licensed under LGPL v2.1.