summaryrefslogtreecommitdiff
path: root/examples/webchannel/nodejs/README
diff options
context:
space:
mode:
Diffstat (limited to 'examples/webchannel/nodejs/README')
-rw-r--r--examples/webchannel/nodejs/README14
1 files changed, 14 insertions, 0 deletions
diff --git a/examples/webchannel/nodejs/README b/examples/webchannel/nodejs/README
new file mode 100644
index 0000000..07f8fd8
--- /dev/null
+++ b/examples/webchannel/nodejs/README
@@ -0,0 +1,14 @@
+This is a small NodeJS implementation on how to connect to a QWebChannel.
+
+This example implements a small chat client using the command line. It connects
+to the server provided by the other example 'examples/standalone/standalone'. Of
+course the port the server listens on must be known.
+
+How to run it:
+
+- Install NodeJS (at least 0.10.x) (http://www.nodejs.org/download/)
+- go to examples/nodejs and execute "npm install". This sets up the nodeJS
+ environment in this folder
+- ensure examples/standalone/standalone is running
+- execute the example with "node chatclient.js"
+