code cleanup / local variables

[contrib/cloudeebus.git] / README.md

diff --git a/README.md b/README.md
index 74e7575..44c322b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -16,25 +16,41 @@ Cloudeebus will install itself in Python's dist-packages folder. The
 
        sudo python setup.py install
 
+See the [Getting Started](https://github.com/01org/cloudeebus/wiki/Getting-started)
+ section of the [Cloudeebus wiki](https://github.com/01org/cloudeebus/wiki)
+ for a list of dependencies to install.
+
 
 ### Running Cloudeebus:
 
 The Cloudeebus server must be run either with credentials and a whitelist to
  restrict access to DBus services, or in opendoor mode.
 
-       usage: cloudeebus.py [-h] [-d] [-o] [-p PORT] [-c CREDENTIALS] [-w WHITELIST]
+       usage: cloudeebus.py [-h] [-v] [-d] [-o] [-p PORT] [-c CREDENTIALS] [-w WHITELIST] [-n NETMASK,IP ADDRESS]
        
        Javascript DBus bridge.
        
        optional arguments:
          -h, --help            show this help message and exit
          -d, --debug           log debug info on standard output
+         -v, --version         print version and exit
          -o, --opendoor        allow anonymous access to all services
          -p PORT, --port PORT  port number
          -c CREDENTIALS, --credentials CREDENTIALS
                                path to credentials file
          -w WHITELIST, --whitelist WHITELIST
                                path to whitelist file
+         -n NETMASK, --netmask NETMASK
+                               netmask,IP filter (comma separated.) eg. :
+                               -n 127.0.0.1,192.168.2.0/24,10.12.16.0/255.255.255.0
+
+
+Documentation
+-------------
+
+  * [Cloudeebus](http://01.org/cloudeebus) project home page on [01.org](http://01.org)
+  * [Javascript API](https://github.com/01org/cloudeebus/wiki/API) reference.
+  * [Architecture](https://github.com/01org/cloudeebus/wiki/Architecture) block diagram.
 
 
 Examples
@@ -45,7 +61,7 @@ Examples
 The /doc/dbus-tools folder contains dbus-send and dbus-register test pages.
 Cloudeebus runs in opendoor mode, the dbus-tools pages have no manifest.
 
-       cloudeebus.py --debug --opendoor &
+       cloudeebus.py --debug --opendoor --port=9001 &
        firefox ./doc/dbus-tools/dbus-register.html ./doc/dbus-tools/dbus-send.html &
 
 ### sample
@@ -57,6 +73,8 @@ Cloudeebus runs with credentials and a whitelist that are matched by the
        cloudeebus.py --debug --credentials=./doc/sample/CREDENTIALS --whitelist=./doc/sample/WHITELIST &
        firefox ./doc/sample/cloudeebus.html &
 
+The sample page is also online as a [live demo](http://01org.github.com/cloudeebus/).
+
 
 Acknowledgements
 ----------------