summaryrefslogtreecommitdiff
path: root/examples/webchannel/qwclient/README
diff options
context:
space:
mode:
Diffstat (limited to 'examples/webchannel/qwclient/README')
-rw-r--r--examples/webchannel/qwclient/README18
1 files changed, 18 insertions, 0 deletions
diff --git a/examples/webchannel/qwclient/README b/examples/webchannel/qwclient/README
new file mode 100644
index 0000000..2b90427
--- /dev/null
+++ b/examples/webchannel/qwclient/README
@@ -0,0 +1,18 @@
+A REPL client for any qwebchannel service using a websocket transport.
+
+A nice tool for testing qwebchannel endpoints.
+
+Install:
+ - qmake && make from the qwebchannel sources or examples.
+ - npm install
+
+Usage:
+ - qwclient.js <autoconnect server>
+ - openChannel(url) in the REPL to open a new connection, multiple channels are OK
+ - channel object lists are aliased to c<channelnumber> i.e. c0, c1, ...
+
+ Example using the standalone example server:
+ - Launch standalone example server
+ - qwclient localhost:12345
+ - c0.receiveText('test')
+ - 'test' should be displayed in the standalone server UI