Update README.md (screenshot, target instructions)

[src/app-framework-demo.git] / afb-client / README.md

diff --git a/afb-client/README.md b/afb-client/README.md
index 3893f1f..4e0796f 100644 (file)
--- a/afb-client/README.md
+++ b/afb-client/README.md
@@ -1,14 +1,19 @@
+### Sample client application for Application Framework Binder
+
+![AFB-Client screenshot](http://iot.bzh/images/afb-client.jpg)
+
+_(Application Framework Binder can be found on https://github.com/iotbzh/afb-daemon)_
 
 ## Installation
 
 Install HTML5 development toolchain on your host
 
     1. Check out this repository
-       git clone https://github.com/iotbzh/afb-client-sample.git
+       git clone https://github.com/iotbzh/afb-client.git
 
     2) Install NodeJs [not used on target] 
-        zypper install nodejs
-        yum install nodejs
+       zypper install nodejs
+       yum install nodejs
 
     3) Install building tools [bower, gulp, ....]
        npm install # this install all development tool chain dependencies
@@ -18,7 +23,7 @@ Install HTML5 development toolchain on your host
        install [livereload Chrome extension](https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei)
 
 
-### Overload ./etc/Defaults.js with '.noderc.js'
+### Overload ./app/etc/AppDefaults.js with '.noderc.js'
     var config= {
         APPNAME : 'AFBclient',   // AppName is use as main Angular Module name
         FRONTEND: "Frontend",    // HTML5 frontend  [no leading ./]
@@ -40,13 +45,16 @@ Install HTML5 development toolchain on your host
     gulp watch-dev 
     http://localhost:3001/opa  /* debug mock api base on Backend/RestApi */
 
-### Test with Application server binder  [you may safely run gulp 'watch-dev' + 'afb-daemon' simultaneously]
-    export MYWORKSPACE=$HOME/Workspace
-    $MYWORKSPACE/afb-daemon/build/afb-daemon --port=1234 --verbose --token=123456789 --rootdir=$MYWORKSPACE/afb-client/dist.dev
-    http://localhost:1234/opa
+### Test with Application server binder
+
+    # Start AppFramework Binder
+        export MYWORKSPACE=$HOME/Workspace
+        $MYWORKSPACE/afb-daemon/build/afb-daemon --port=1234 --verbose --token=123456789 --rootdir=$MYWORKSPACE/afb-client/dist.dev
+
+    Point your browser onto: http://localhost:1234/opa
 
     Note: 
-      - do not forget "/opa" that should match with your config.URLBASE
+      - do not forget '/opa' that should match with your config.URLBASE
       - if you change --token=xxxx do not forget to update ./Frontend/pages/HomeModules.js
       - Force HTML/OPA reload with F5 after each HTML5/OPA update or new pages may not be loaded. 
       - When reloading HTML/OPA with F5 do not forget that your initial token wont be accepted anymore. You should either restart to clean existing session or cleanup AJB_session cookie.
@@ -54,8 +62,11 @@ Install HTML5 development toolchain on your host
 ### Move to Target
     cd $MYWORKSPACE/afb-client
     gulp build-app-prod
-    scp -r ./dist.pro/* user@mytarget:/rootdir/apfDaemon
+    scp -r ./dist.prod/* user@mytarget:/rootdir/afb-client
+    ssh user@mytarget "afb-daemon --port=3001 --token='' --rootdir=/rootdir/afb-client"
+    http://mytarget:3001/opa
 
+### Directory structure
     /AppClient
     |
     |---- package.json
@@ -92,4 +103,3 @@ Install HTML5 development toolchain on your host
     |---- (/dist.dev)
     |---- (/dist.prod)
 
-    
\ No newline at end of file