diff --git a/CHANGELOG.md b/CHANGELOG.md index e6766a1..6039e50 100644 --- 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 index 6ac7e93..b6cabc5 100644 --- 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:`](https://github.com/orgs/uclahs-cds/packages/container/package/pipeval) diff --git a/pipeval_flowchart.png b/pipeval_flowchart.png new file mode 100644 index 0000000..5ffa891 Binary files /dev/null and b/pipeval_flowchart.png differ