summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorBrad Bishop <bradleyb@fuzziesquirrel.com>2016-10-21 22:37:17 -0400
committerBrad Bishop <bradleyb@fuzziesquirrel.com>2016-11-08 15:01:04 -0500
commitafbd28efcc2a070c0d6b9ec1a8bb392bdd54d0d6 (patch)
treeceada640e48be6da717cd5069afa8f3365c2a686 /README.md
parent656a7d0071d1a896c5fa53320de4a138d9332bd5 (diff)
downloadphosphor-inventory-manager-afbd28efcc2a070c0d6b9ec1a8bb392bdd54d0d6.tar.gz
phosphor-inventory-manager-afbd28efcc2a070c0d6b9ec1a8bb392bdd54d0d6.zip
README formatting update.
Change filter/action identifier from name to type for consistancy. Minor formatting tweaks. Change-Id: If4e34ac7b9b76b12e4bd6b72c49cd324c229e32f Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 10 insertions, 6 deletions
diff --git a/README.md b/README.md
index 5cdb260..2efecfb 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,7 @@ The following top level YAML tags are supported:
----
**events**
+
Supported event tags are:
* name - A globally unique event name.
@@ -26,12 +27,13 @@ Subsequent tags are defined by the event type.
----
**action**
+
Supported action tags are:
-* name - The action name.
+* type - The action to perform.
* args - An optional list of arguments to pass to the action.
-* value - The argument value.
-* type - The argument type (defaults to string if unspecified).
+ * value - The argument value.
+ * type - The argument type (defaults to string if unspecified).
The available actions provided by PIM are:
@@ -40,6 +42,7 @@ The available actions provided by PIM are:
----
**match**
+
Supported match tags are:
* signature - A DBus match specification.
@@ -47,12 +50,13 @@ Supported match tags are:
----
**filter**
+
Supported filter tags are:
-* name - The name of the filter.
+* type - The filter to use.
* args - An optional list of arguments to pass to the filter.
-* value - The argument value.
-* type - The argument type (defaults to string if unspecified).
+ * value - The argument value.
+ * type - The argument type (defaults to string if unspecified).
The available filters provided by PIM are:
OpenPOWER on IntegriCloud