From cd42e4576102ba1ac69e0d6236f429e6b09c4968 Mon Sep 17 00:00:00 2001
From: Phil Owen <19691521+PhillipsOwen@users.noreply.github.com>
Date: Mon, 12 Jun 2023 11:00:26 -0400
Subject: [PATCH] final tweaks on the readmes

---
 README.md | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e550d09..48de81c 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ SPDX-License-Identifier: MIT
 ![image not found](renci-logo.png "RENCI")
 
 # APSViz Supervisor
-A tool that creates and launches various APSViz kubernetes jobs to create image products for the APSViz TerriaMap UI.
+A Workflow manager that creates and monitors K8s jobs for each data processing component.
 
 #### Licenses...
 [![MIT License](https://img.shields.io/badge/License-MIT-orange.svg)](https://github.com/RENCI/APSVIZ-Supervisor/blob/master/LICENSE)
@@ -21,3 +21,20 @@ A tool that creates and launches various APSViz kubernetes jobs to create image
 #### Build status...
 [![PyLint the codebase](https://github.com/RENCI/APSVIZ-Supervisor/actions/workflows/pylint.yml/badge.svg)](https://github.com/RENCI/APSVIZ-Supervisor/actions/workflows/pylint.yml)
 [![Build and push the Docker image](https://github.com/RENCI/APSVIZ-Supervisor/actions/workflows/image-push.yml/badge.svg)](https://github.com/RENCI/APSVIZ-Supervisor/actions/workflows/image-push.yml)
+
+## Description
+This product is a workflow manager that sequences microservices deployed in a K8s environment.
+
+The APSViz Job supervisor has the following features:
+ - Integrates directly with K8s using the K8s API to create and monitor jobs.
+ - Monitors each K8s job from creation to completion
+ - Robust error handling.
+ - Broadcasts the run state of each request (success, failure) using Slack.
+ - K8s Job definitions for each workflow process are stored in a database.
+ - K8s Job settings are configurable via the [APSViz settings application](https://github.com/RENCI/APSVIZ-Settings).
+
+There are GitHub actions to maintain code quality in this repo:
+ - Pylint (minimum score of 10/10 to pass),
+ - Build/publish a Docker image.
+
+Helm/k8s charts for this product are available at: [APSViz-Helm](https://github.com/RENCI/apsviz-helm/tree/main/supervisor).
\ No newline at end of file