Mark html page as being utf-8

[contrib/qtwebsockets.git] / README.md

diff --git a/README.md b/README.md
index dac882b..b164a22 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,32 +1,37 @@
-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.
-
-Features
---------
+### 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.
+
+### Features
+* Client and server capable
 * Text and binary sockets
 * Frame-based and message-based signals
-* Works through proxies
-
+* Strict Unicode checking
+* WSS and proxy support
 
-Requirements
-------------
+### 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.
+### 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
-----------------
-* WSS protocol
-* Checks on valid UTF-8 sequences
+### Missing Features
 * Extensions and sub-protocols
 
-License
--------
-This code is licensed under LGPL v3.
\ No newline at end of file
+### License
+This code is licensed under LGPL v2.1.