diff --git a/README.md b/README.md new file mode 100644 index 00000000..08513504 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# trivy-plugin-aqua +A [Trivy](https://github.com/aquasecurity/trivy) plugin that scans infrastructure as code templates + +## Install + +``` +$ trivy plugin install github.com/aquasecurity/trivy-plugin-aqua +$ trivy aqua -h +Usage: trivy aqua [-h,--help] TYPE NAME [TRIVY OPTION] + A Trivy plugin that scans infrastructure as code templates. + +Options: + -h, --help Show usage. + +Examples: + # Scan an IaC file + trivy plugin run aqua iac --aqua-key --aqua-secret + +``` + +## Usage +Trivy's options need to be passed after `--`. + +``` +# Scan an IaC file +trivy plugin run aqua iac --aqua-key --aqua-secret +``` +