Update README.md (plugins, code sample)

Updated :
- plugins are now implemented ;
- data structures in code sample have changed ;
- various typos and style details.

Signed-off-by: Manuel Bachmann <manuel.bachmann@iot.bzh>

diff --git a/README.md b/README.md
index c54c0f1..4d2f8b0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,93 +1,92 @@
 ### Application Framework Binder
 This is an undergoing work, publication is only intended for developers to review and provide feedback.
 
-### Licence
-As today the code is under GLPV3, while no decision as been taken yet, it will certainly move under a different licence like GPV2, Apache or MIT.
+### License
+As of today, the code is licensed under GLPv3. While no decision as been taken yet, it will certainly switch to a different licence: GPLv2, Apache or MIT e.g..
 
-Final goal is keep the engine public while allowing people to load non open-source plugins. The code already leverage other opensource 
-libraries especially libmicrohttpd & libjson. Finally what ever Licence is chosen it should be compatible with dependencies and automotive
-industry requirementsas the primary target for this code is AGL. 
+Final goal is to keep the engine publicly accessible and modifiable, still allowing people to load non open-source plugins. The code itself already leverages open-source libraries, including libmicrohttpd & libjson.
 
-### Building
- Building Application Framework Binder requires the following libraries:
+Finally, whatever license is chosen, it should be compatible with dependencies and automotive industry requirements - as the primary target for this code is AGL. 
 
+### Building
+Building Application Framework Binder requires the following libraries:
  * libmagic ("libmagic-dev" under Debian/Ubuntu, "file-devel" under OpenSUSE);
  * libmicrohttpd ("libmicrohttpd-dev/devel");
  * json-c ("libjson-c-dev/devel");
  * uuid ("uuid-dev/libuuid-devel");
  * dbus ("libdbus-1-dev/dbus-1-devel");
 
- optionally, for plugins :
-
+optionally, for plugins :
  * alsa ("libasound2-dev/alsa-devel");
  * rtl-sdr >= 0.5.0 (fetch and build from "git://git.osmocom.org/rtl-sdr");
 
- and the following tools:
-
+and the following tools:
  * pkg-config;
  * cmake >= 2.8.8.
 
-To install all dependencies under OpenSUSE (except rtl-sdr), please type:
-
-$ zypper in file-devel libmicrohttpd-devel libjson-c-devel libuuid-devel pkg-config cmake
-
- To build from the root directory, please type:
+To install all dependencies under OpenSUSE (excepting rtl-sdr), please type:
+```
+$ zypper in file-devel libmicrohttpd-devel libjson-c-devel libuuid-devel dbus-1-devel pkg-config cmake
+```
 
+ To build, move to the root directory and type:
+```
 $ mkdir build; cd build<br />
 $ cmake ..<br />
 $ make; make install<br />
+```
 
-### Start
+### Starting
+```
 $ afb-daemon --help 
+$ afb-daemon --verbose --port=<port> --token='' --sessiondir=<working directory> --rootdir=<web directory (index.html)>
+```
 
 ### Example
-$ afb-daemon --verbose --rootdir=/home/fulup/.AFB --alias=icons:/usr/share/icons
+```
+$ afb-daemon --verbose --port=1234 --token='' --sessiondir=/tmp --rootdir=/srv/www/htdocs --alias=icons:/usr/share/icons
+```
 
-### Directory & Path
+### Directories & Paths
 Default behaviour is to locate ROOTDIR in $HOME/.AFB
 
 ### REST API
 
-Developer should mainly provides a structure with APIs name, corresponding methods and optionally some context and a handle.
-A handle is a void* structure that it is passed to the api callback. The API receive the query and well as post data, incase
-a post method was used. Every method should return a JSON object or NULL in case of error.
+Developers are intended to provide a structure containing : API name, corresponding methods/callbacks, and optionally a context and a handle.
+A handle is a void* structure automatically passed to API callbacks. Callbacks also receive HTTP GET data as well as HTTP POST data, in case a POST method was used. Every method should return a JSON object or NULL in case of error.
 
-API plugin can be protected from timeout and other errors. By default this behaviour is deactivated, use --apitimeout to activate it.
+API plugins can be protected from timeout and other errors. By default this behaviour is deactivated, use --apitimeout to activate it.
         
-        STATIC  AFB_restapi myApis[]= {
-          {"ping"     , (AFB_apiCB)ping    , "Ping Function", NULL},
-          {"action1"  , (AFB_apiCB)action1 , "Action-1", OptionalHandle},
-          {"action2"  , (AFB_apiCB)action2 , "Action-2", OptionalHandle},
-          {0,0,0}
+        STATIC AFB_restapi myApis[]= {
+          {"ping"    , AFB_SESSION_NONE,  (AFB_apiCB)ping,     "Ping Function"},
+          {"action1" , AFB_SESSION_CHECK, (AFB_apiCB)action1 , "Action-1"},
+          {"action2" , AFB_SESSION_CHECK, (AFB_apiCB)action2 , "Action-2"},
+          {NULL}
         };
 
-        PUBLIC AFB_plugin *pluginRegister (AFB_session *session) {
+        PUBLIC AFB_plugin *pluginRegister () {
             AFB_plugin *plugin = malloc (sizeof (AFB_plugin));
-            plugin->type  = AFB_PLUGIN;
+            plugin->type  = AFB_PLUGIN_JSON;
             plugin->info  = "Plugin Sample";
-            plugin->prefix= "myplugin";        
+            plugin->prefix= "myPlugin";        
             plugin->apis  = myApis;
             return (plugin);
         }
 
-### HTML5 and Angular Redirect
+### HTML5 and AngularJS Redirects
 
-Binder support HTML5 redirect mode even with an application baseurl. Default value for application base URL is /opa
+Binder supports HTML5 redirect mode even with an application baseurl. Default value for application base URL is /opa.
 See Application Framework HTML5 Client template at https://github.com/iotbzh/afb-client-sample
 
-If the Binder receive something like http://myopa/sample when sample is not the homepage of the Angular OPA. The the serveur
-will redirect to http://myopa/#!sample this redirect will return the Index.html OPA file and will notify angular not to display
-the homepage by to goto samplepage.
+If the Binder receives something like _http://myopa/sample_ when sample is not the homepage of the AngularJS OPA, it will redirect to _http://myopa/#!sample_. This redirect will return the _index.html_ OPA file and will notify AngularJS not to display the homepage, but the sample page.
 
-Warning: in order Angular application to work both with a BASEURL="/" and BASEURL="/MyApp/" every page references have to be relative.
-Recommended model is to develop with a BASEURL="/opa" as any application working with a BASEURL will work without, when the opposite it not true.
+Warning: in order for AngularJS applications to be able to work with both BASEURL="/" and BASEURL="/MyApp/", all page references have to be relative.
+Recommended model is to develop with a BASEURL="/opa" as any application working with a BASEURL will work without, while the opposite is not true.
 
-Note: If a resource is not accessible from ROOTDIR then --alias should be use ex: --alias=/icons:/usr/share/icons. Only alias designed to access
-external support static files. They should not be used for API and OPA.
+Note: If a resource is not accessible from ROOTDIR then the "--alias" switch should be used, as in: --alias=/icons:/usr/share/icons. Only use alias for external support static files. This should not be used for API and OPA.
 
 
-### On going work
+### Ongoing work
 
- -- Dynamic load of plugins. While everything is designed to support dynamically loadable plugins, this part is not done yet.
- -- Javascript plugins. As today only C plugins are supported, but JS plugins are on the ToDo list.
+Javascript plugins. As of today, only C plugins are supported, but JS plugins are on the TODO list.