summary refs log tree commit diff
path: root/syweb/webclient/README
diff options
context:
space:
mode:
authorMark Haines <mark.haines@matrix.org>2014-11-04 15:57:23 +0000
committerMark Haines <mark.haines@matrix.org>2014-11-04 15:57:23 +0000
commit89ba802b23bf1fd22afbc5e9a4b3b732264e3c18 (patch)
tree34b7803cf8dfb570165c1b1c6f674dc5ca4476c7 /syweb/webclient/README
parentMerge pull request #11 from matrix-org/webclient-room-data-restructure (diff)
downloadsynapse-89ba802b23bf1fd22afbc5e9a4b3b732264e3c18.tar.xz
Move webclient to a python module so that it can be installed
Diffstat (limited to 'syweb/webclient/README')
-rw-r--r--syweb/webclient/README13
1 files changed, 13 insertions, 0 deletions
diff --git a/syweb/webclient/README b/syweb/webclient/README
new file mode 100644
index 0000000000..ef79b25708
--- /dev/null
+++ b/syweb/webclient/README
@@ -0,0 +1,13 @@
+Basic Usage
+-----------
+
+The web client should automatically run when running the home server. 
+Alternatively, you can run it stand-alone:
+
+    $ python -m SimpleHTTPServer
+
+Then, open this URL in a WEB browser::
+
+    http://127.0.0.1:8000/
+
+