update

[umurmur.git] / shm_utils / umurmurd-websocket / README.md

diff --git a/shm_utils/umurmurd-websocket/README.md b/shm_utils/umurmurd-websocket/README.md
new file mode 100644 (file)
index 0000000..fa2611c
--- /dev/null
+++ b/shm_utils/umurmurd-websocket/README.md
@@ -0,0 +1,29 @@
+uMurmurd-Websocket - HTTP/JSON server example\r
+=============================================\r
+\r
+HTTP/JSON server in one. Useing a js prettyprinter type lib to display the output\r
+It not the best looking but its just a demo. Hopeing someone else with better web \r
+skills can make something better.\r
+  \r
+\r
+Instructions for building from source\r
+-------------------------------------\r
+1. Requirements\r
+  * [OpenSSL](http://www.openssl.org/)\r
+       * [libwebsockets](http://libwebsockets.org) library. I used this [tarball]([http://git.libwebsockets.org/cgi-bin/cgit/libwebsockets/snapshot/libwebsockets-1.23-chrome32-firefox24.tar.gz) \r
+  * [Jansson](www.digip.org/jansson/) library.  I used this [tarball](http://www.digip.org/jansson/releases/jansson-2.6.tar.gz) Jansson is a C library for encoding, decoding and manipulating JSON data\r
+  * [CMake](http://cmake.org) \r
+\r
+2. Build - CMake\r
+       * Create a build folder and cd into it\r
+       * `cmake ../`\r
+       * `make`\r
+\r
+3. Run\r
+  * start umurmurd from this git like this ./umurmurd -d -c <conf file>\r
+       - the -d option is just to make it easier to see debug info\r
+  * start uMurmurd-Websocket with ./uMurmurd-Websocket --ssl \r
+       - option --ssl is for https://, http:// otherwise\r
+  * point web browser to https://localhost:7681      \r
+\r
+          
\ No newline at end of file