1 files changed, 28 insertions, 0 deletions
diff --git a/plugins/dbus/README b/plugins/dbus/README
new file mode 100644
index 00000000..f902ffad
--- /dev/null
+++ b/plugins/dbus/README
@@ -0,0 +1,28 @@
+# DBus plugin                {#dbus_plugin}
+Version: @PROJECT_VERSION@
+
+This plugin provides a nice DBus API to application who want access to AMB data.
+
+To use the DBus plugin, add the following to the "sinks" array in /etc/ambd/config:
+
+~~~~~~~~~~~~~{.json}
+{
+	"name" : "dbussink",
+	"path" : "@PLUGIN_INSTALL_PATH@/dbussinkplugin.so",
+	"frequency" : "60"
+}
+~~~~~~~~~~~~~
+
+## Configuration Key Definitions:
+
+"name"
+name of plugin.  This key is not used by the plugin at this moment.
+
+"path"
+path to plugin on the filesystem.
+
+"frequency"
+Frequency in Hz which AMB will fire dbus signals.  AMB will fire the most recent values at this rate.
+
+Default: 60
+