Add diagram (#83)

* Add flowchart * Update CHANGELOG * Add PNG file * Update registry for CICD image * Revert to older CICD * Use GitHub registry CICD * Fix linting * Trigger static analysis
uclahs-cds · May 13, 2024 · 05ca2ea · 05ca2ea
1 parent e23acee
commit 05ca2ea
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,12 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ---
 
+## [Unreleased]
+### Added
+- Add validation flowchart
+
+---
+
 ## [5.0.0] - 2024-02-16
 ### Added
 - Validation skip functionality for checksums

diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
 # PipeVal
 
 - [Overview](#overview)
+    - [Validation Flowchart](#validation-flowchart)
 - [Docker](#docker)
 - [Installation](#installation)
     - [From GitHub](#install-directly-from-github)
@@ -21,6 +22,10 @@ PipeVal is an easy to use CLI tool that can be used to validate different inputs
 
 Its primary functions are to generate and/or compare checksum files and validate input files.
 
+### Validation Flowchart
+![flowchart](./pipeval_flowchart.png)
+
+
 ## Docker
 The tool can be used via the docker image [`ghcr.io/uclahs-cds/pipeval:<tag>`](https://github.com/orgs/uclahs-cds/packages/container/package/pipeval)
 

diff --git a/pipeval_flowchart.png b/pipeval_flowchart.png