diff options
author | Kurt Pattyn <kurt.pattyn@barco.com> | 2013-08-03 18:21:36 +0200 |
---|---|---|
committer | Kurt Pattyn <kurt.pattyn@barco.com> | 2013-08-03 18:21:36 +0200 |
commit | 081905a65e9efcb35c3d0fcc85f947b9bf18d5d2 (patch) | |
tree | 7055ffa9f445e9379437090d766ae05538d49066 /README.md | |
parent | f8e0d44e6b76ae1dfcbe1de542afbe2d849fb16f (diff) | |
download | qtwebsockets-081905a65e9efcb35c3d0fcc85f947b9bf18d5d2.tar.gz |
Created first version of the readme file.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 29 |
1 files changed, 28 insertions, 1 deletions
@@ -1,4 +1,31 @@ QWebSockets =========== +Introduction +------------ +QWebSockets is a pure Qt implementation of WebSockets - both client and server. +It is implemented as a source code module (.pri file), that can easily be embedded into existing Qt projects. It has no other dependencies that Qt. -Pure Qt implementation of WebSockets -both client and server +Features +-------- +* Text and binary sockets +* Frame-based and message-based signals +* Works through proxies + + +Requirements +------------ +Qt 5.x + +Compliance +---------- +QWebSockets 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). +Only tests with **invalid UTF-8 sequences** do **not** pass from the Autobahn Testsuite. + +Missing Features +---------------- +* WSS protocol +* Checks on valid UTF-8 sequences + +License +------- +This code is licensed under LGPL v3.
\ No newline at end of file |