summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKurt Pattyn <KurtPattyn@users.noreply.github.com>2013-08-19 23:34:08 +0200
committerKurt Pattyn <KurtPattyn@users.noreply.github.com>2013-08-19 23:34:08 +0200
commit7794b312abe58e59d08e42e7e403a7473e8d7123 (patch)
tree6b4640970f99630419cc1521b4b782e245322102 /README.md
parenta3b2ead6f2e8e1a09569b0b2ac7ff2e3613fad25 (diff)
downloadqtwebsockets-7794b312abe58e59d08e42e7e403a7473e8d7123.tar.gz
Add usage paragraph
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index a7a229f..5f81fd5 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,12 @@ With QWebSockets, text messages are just that: a collection of human-readable ch
### Requirements
Qt 5.x
+### Usage
+Include the .pri file into your Qt project
+~~~
+include (websocket.pri)
+~~~
+
### 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 **Unicode non-characters** do **not** pass from the Autobahn Testsuite (see [Restrictions](#Restrictions)).