README.md

   1 ### Introduction
   2 `QtWebSockets` is a pure Qt implementation of WebSockets - both client and server.
   3 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.
   4
   5 ### Features
   6 * Client and server capable
   7 * Text and binary sockets
   8 * Frame-based and message-based signals
   9 * Strict Unicode checking
  10 * WSS and proxy support
  11
  12 ### Requirements
  13 Qt 5.x
  14
  15 ### Build And Usage
  16 Checkout the source code from gitorious
  17 Go into the source directory and execute:
  18
  19     qmake
  20     make
  21     make install
  22
  23
  24 The last command will install `QtWebSockets` as a Qt module.
  25
  26 To use, add `websockets` to the QT variable.
  27
  28 `QT += websockets`
  29
  30 ### Compliance
  31 `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).
  32
  33 ### Missing Features
  34 * Extensions and sub-protocols
  35
  36 ### License
  37 This code is licensed under LGPL v2.1.