From 974156ccdecee05eb9544b0b21cc0351428ddd43 Mon Sep 17 00:00:00 2001
From: Clumsy-Coder <19594044+Clumsy-Coder@users.noreply.github.com>
Date: Thu, 11 Aug 2022 21:12:47 -0600
Subject: [PATCH] docs(readme): add docs for using shell conditionally

  ## what
  - add documentation on using shell command conditionally

  ## how

  ## why

  ## where

  ## usage
---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index 9cdea47..a32aaf7 100644
--- a/README.md
+++ b/README.md
@@ -332,6 +332,7 @@ fine-grained control.
 | `stdin` | Allow a command to read from standard input (default: false) |
 | `stdout` | Show a command's output from stdout (default: false) |
 | `stderr` | Show a command's error output from stderr (default: false) |
+| `if` | Run command if a condition is true (default: true) (optional) |
 
 Note that `quiet` controls whether the command (a string) is printed in log
 output, it does not control whether the output from running the command is
@@ -356,6 +357,19 @@ printed (that is controlled by `stdout` / `stderr`). When a command's `stdin` /
     stderr: true
 ```
 
+##### Running shell command conditionally
+
+```yaml
+- shell:
+    - command: apt update && apt upgrade -y
+      if: lsb_release -i | grep -io 'debian'
+      description: Update APT package repository
+
+    - command: dnf update -y
+      if: lsb_release -i | grep -io 'fedora'
+      description: Update DNF package repository
+```
+
 ### Clean
 
 Clean commands specify directories that should be checked for dead symbolic