projects / henge / kiak.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
usage
[henge/kiak.git] / usage
diff --git a/usage b/usage
index 3d3eeee..7aa10d9 100644 (file)
--- a/usage
+++ b/usage
@@ -27,20 +27,19 @@ ROUTING
                           established by separating the key:value pairs with ','
                           commas. (www:./www)
                           e.g. Service a typical frontpage
-                            -i./html/index.html -b js:./js,html:./html,css:./css
+                            -i./html/index.html -bjs:./js,html:./html,css:./css
                           e.g. Route-based http hosting
-                            -b user1:/home/user1/www,user2:/home/user2/www
+                            -buser1:/home/user1/www,user2:/home/user2/www
   -e, --electron=string   Specify a route name for the local electron render
                           window which will be launched on execution (nil)
                           - enables optional electron dependency
   -d, --dedicated=string  Route all incoming connections to this route (nil)
                           - can be used in conjunction with '-e' for single-user
-                          e.g. Set the electron window to use route 'default',
-                               Set the dedicated route to 'default'
-                          $ node strapp.js -e default -d default
-                            - All routes point to 'default' which is bound to
-                              the local electron window.  No other hosts may
-                              be established, so no remote hosts may exist
+                          e.g. Create a dedicated electron listener
+                            - strapp -edefault -ddefault
+                              - All routes point to 'default' which is bound to
+                                the local electron window.  No other hosts may
+                                be established, so no remote hosts may exist
 
 COMPATIBILITY
   --legacy-socket=bool    Use Socket.io compatibility layer to enable 
kiak isn't a kernel, it's a json-based filesystem that runs in browser memory and provides filesystem abstractions for general i/o, webrtc, webcrypto and webgl. it also provides a node.js server bridge over a websocket, providing restricted server-side filesystem access. the node.js server acts as a router, using URLs to route messages to the bridged 'remote admin', who then may receive HTTP and TCP connections in the browser. any application written for the kiak browser environment may also run on the node.js server. developed for the HENGE engine, but also an independent project providing a multi-user application framework (e.g. for multiplayer web games, screen sharing, or pair programming). the web-client is also a kiak routing server, so it can act as a host for its own clients, who may recursively act as servers for their own clients over WebRTC, and so on.