Update project documentation

[wesley-dean]

Fixes #

Proposed Changes

1. …
2. …
3. …

Readiness Checklist

• If documentation is needed for this change, has that been included in this pull request

Reviewing Maintainer

• Label as breaking if this is a large fundamental change
• Label as either automation, bug, documentation, enhancement, infrastructure, or performance

[github-actions]

✅MegaLinter analysis: Success

Descriptor	Linter	Files	Fixed	Errors	Warnings	Elapsed time
✅ BASH	shellcheck	24		0	0	2.1s
✅ REPOSITORY	betterleaks	yes		no	no	2.18s
✅ REPOSITORY	checkov	yes		no	no	31.14s
✅ REPOSITORY	gitleaks	yes		no	no	0.59s
✅ REPOSITORY	grype	yes		no	no	79.33s
✅ REPOSITORY	kingfisher	yes		no	no	8.58s
✅ REPOSITORY	secretlint	yes		no	no	2.06s
✅ REPOSITORY	semgrep	yes		no	no	31.09s
✅ REPOSITORY	syft	yes		no	no	2.9s
✅ REPOSITORY	trivy	yes		no	no	13.6s
✅ REPOSITORY	trivy-sbom	yes		no	no	0.24s
✅ REPOSITORY	trufflehog	yes		no	no	7.39s

Notices

📣 MegaLinter 9.5.0 is out! Discover the new features and security recommendations in the release announcement. (Skip this info by defining SECURITY_SUGGESTIONS: false)

See detailed reports in MegaLinter artifacts

Your project could benefit from a custom flavor, which would allow you to run only the linters you need, and thus improve runtime performances. (Skip this info by defining FLAVOR_SUGGESTIONS: false)

• Documentation: Custom Flavors
• Command: npx mega-linter-runner@9.6.0 --custom-flavor-setup --custom-flavor-linters BASH_SHELLCHECK,REPOSITORY_CHECKOV,REPOSITORY_GITLEAKS,REPOSITORY_BETTERLEAKS,REPOSITORY_GRYPE,REPOSITORY_SECRETLINT,REPOSITORY_SEMGREP,REPOSITORY_SYFT,REPOSITORY_TRIVY,REPOSITORY_TRIVY_SBOM,REPOSITORY_TRUFFLEHOG,REPOSITORY_KINGFISHER

Show us your support by starring ⭐ the repository