From bf066a6396771214b2a9c47444b991f2750c0cfc Mon Sep 17 00:00:00 2001
From: Brad Bishop <bradleyb@fuzziesquirrel.com>
Date: Wed, 19 Oct 2016 08:09:44 -0400
Subject: Parse match rules

The 'pimgen.py' parser will parse one or more yaml files containing
inventory manager match rules and generate the required c++ header
file.

Change-Id: Id3b116450bd56487e266590dd339b93db9bc7d27
Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
---
 README.md | 49 +++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 43 insertions(+), 6 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 5318177..a06a572 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,47 @@
-## To Build
+Phosphor Inventory Manager (PIM) is an implementation of the
+xyz.openbmc_project.Inventory.Manager DBus interface, and supporting tools.
+PIM uses a combination of build-time YAML files and run-time calls to the
+Notify method of the Manager interface to provide a generalized inventory
+state management solution.
+
+## YAML
+PIM includes a YAML parser (pimgen.py).  For PIM to do anything useful, a
+set of YAML files must be provided externally that tell it what to do.
+An example can be found in the examples directory.
+
+The following top level YAML tags are supported:
+
+* description - An optional description of the file.
+* events - One or more events that PIM should monitor.
+
+----
+**events**
+Supported event tags are:
+
+* name - A globally unique event name.
+* type - The event type.  Supported types are: *match*.
+
+Subsequent tags are defined by the event type.
+
+----
+**match**
+Supported match tags are:
+
+* signature - A DBus match specification.
+
+----
+
+## Building
+After running pimgen.py, build PIM using the following steps:
+
+```
+    ./bootstrap.sh
+    ./configure ${CONFIGURE_FLAGS}
+    make
 ```
-To build this package, do the following steps:
 
-    1. ./bootstrap.sh
-    2. ./configure ${CONFIGURE_FLAGS}
-    3. make
+To clean the repository run:
 
-To full clean the repository again run `./bootstrap.sh clean`.
+```
+ ./bootstrap.sh clean
 ```
-- 
cgit v1.2.1