svn commit: r1717843 - /incubator/sirona/dashboard/trunk/README.adoc

[rm...@apache.org]

Author: rmannibucau
Date: Thu Dec  3 20:10:58 2015
New Revision: 1717843

URL: http://svn.apache.org/viewvc?rev=1717843&view=rev
Log:
adding few inputs in README

Modified:
    incubator/sirona/dashboard/trunk/README.adoc

Modified: incubator/sirona/dashboard/trunk/README.adoc
URL: http://svn.apache.org/viewvc/incubator/sirona/dashboard/trunk/README.adoc?rev=1717843&r1=1717842&r2=1717843&view=diff
==============================================================================
--- incubator/sirona/dashboard/trunk/README.adoc (original)
+++ incubator/sirona/dashboard/trunk/README.adoc Thu Dec  3 20:10:58 2015
@@ -19,3 +19,16 @@ If you have counters in your application
 
 - security? or let it to the user integration?
 - make sirona plugin more dynamic
+- provide a servlet to get rid of the need to create index.html etc?
+
+=== Extend the plugins
+
+To write an extension: implement `org.apache.sirona.dashboard.plugin.api.Plugin` in a CDI bean. It can be decorated
+with `PluginType` to name the plugin and `@DependsOnCss` and `@DependsOnJs` for frontend dependencies (injected in header/end of body).
+
+The returned widget can parse the formula if it is dynamic and should return the widget HTML content and associated javascript.
+The javascript can use implicit `elt` which is the DOM container of the widget.
+
+=== Package/Embbeded
+
+Just add `sirona-dashboard-plugin` to your dependencies. The front part can be inspired from `sirona-dashboard-plugin/src/main/webapp`.