Updating README: adding badges, updating section information.

Author: Bryan Sieber

README.md

@@ -1,12 +1,58 @@
+![build badge](https://github.com/mozilla/jira-bugzilla-integration/actions/workflows/build-image.yaml/badge.svg)
+![test badge](https://github.com/mozilla/jira-bugzilla-integration/actions/workflows/test-build.yaml/badge.svg)
+
 # Jira Bugzilla Integration (JBI)
-System to sync bugs and issues
+System to sync Bugzilla bugs to Jira issues.
+
+### Caveats
+- The system accepts webhook events from Bugzilla
+- The events are transformed into Jira issues
+- The system POSTs an update to the see_also field of Bugzilla bugs
+- Bugs' whiteboard tags are used to determine if they should be synchronized or ignored
 
 ## Self-Service
 
-If you're interested in using the default action;
-the process is simple to enabling a new downstream
-project. [...read more here.](src/jbi/whiteboard_tags/README.md)
+### Action Configuration
+The action configuration uses a YAML file per environment, this file stores all the configuration information for jbi data flows. The process to enable a new data flow will be explained below.
+
+
+Below is an full example of an action configuration:
+```yaml
+    action: src.jbi.whiteboard_actions.default
+    contact: [[email protected]]
+    description: example configuration
+    enabled: true
+    parameters:
+      jira_project_key: EXMPL
+      whiteboard_tag: example
+```
+
+A bit more about the different fields...
+- `action` (optional)
+    - string
+    - default: [src.jbi.whiteboard_actions.default](src/jbi/whiteboard_actions/default.py)
+    - If using a custom action, place the PYTHONPATH to the custom action python module
+- `contact`
+    - list of strings
+    - If an issue arises with the workflow, communication will be established with this `contact`
+    - Please enter the contact information for one or more stakeholders
+- `description`
+    - string
+    - Please enter a description; for example, team name or project use-case.
+- `enabled` (optional)
+    - bool [true, false]
+    - default: false
+    - If false, matching events will not be synchronized
+- `parameters` (optional)
+    - dict
+    - default: {}
+    - The parameters will be validated to ensure the selected action has all expected parameters
+    - The [default action](src/jbi/whiteboard_actions/default.py) expects both the `whiteboard_tag` and `jira_project_key` fields
+
+
+[View 'dev'  configurations here.](config/config.dev.yaml)
+[View 'prod' configurations here.](config/config.prod.yaml)
+
 
-If you're looking for a unique capability for your
-team's data flow; you can add your own python methods
-and functionality. [...read more here.](src/jbi/whiteboard_actions/README.md)
+### Custom Actions
+If you're looking for a unique capability for your team's data flow, you can add your own python methods and functionality[...read more here.](src/jbi/whiteboard_actions/README.md)