From 799895b7c5156b399ea57130a308e626c9ffe755 Mon Sep 17 00:00:00 2001
From: Seth Landry <waymakerijn@outlook.com>
Date: Thu, 23 Jan 2025 01:26:34 -0600
Subject: [PATCH] Add a new section to the `README.md` file to explain how to
 use the Bandit scan GitHub Action

* Update the section to include an example of the GitHub Actions configuration for running a Bandit scan on a Python project
* Add a description of the configuration options and their purpose
---
 README.md | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 470a3c9..8df778d 100644
--- a/README.md
+++ b/README.md
@@ -98,7 +98,7 @@ cat ./etsthore.json
 
 ## Bandit Scan GitHub Action
 
-To use the Bandit scan GitHub Action for running a Bandit scan on a Python project, you can add the following configuration to your GitHub Actions workflow file:
+To use the Bandit scan GitHub Action for running a security scan on your Python project, you can follow the example GitHub Actions configuration below:
 
 ```yaml
 name: Bandit Scan
@@ -116,3 +116,5 @@ jobs:
           exit_zero: true
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
+
+This configuration will run the Bandit scan on your Python project whenever there is a push or pull request. The `exit_zero: true` option ensures that the scan does not fail the workflow even if issues are found. The `GITHUB_TOKEN` is provided via `${{ secrets.GITHUB_TOKEN }}` for authentication.