Merge pull request #27 from vulncheck-oss/readme-updates-2

🎨 add all optional parameters

README.md

@@ -20,7 +20,7 @@ into your CI/CD pipeline.
 
 ## 🤸 Usage
 
-### 🔏 Scan your project for vulnerabilities
+### 🔏 Scan for vulnerabilities
 
 This example will scan for vulnerabilities and report them as a comment on a
 pull request
@@ -45,3 +45,27 @@ jobs:
           command: scan
           token: ${{ secrets.VC_TOKEN }}
 ```
+
+### 💅 Customizing
+
+The only required parameter for any command is the `token` parameter. This is
+your VulnCheck API token that can be created in hte portal.
+
+> [!Important]
+>
+> We recommend you store this token as a secret in either repository or
+> organization.
+
+The following are optional parameters that can be used with the `scan` command
+
+| Name                           | Description                   | Default |
+| ------------------------------ | ----------------------------- | ------- |
+| `scan-path`                    | Path to the directory to scan | `./`    |
+| `scan-cvss-base-threshold`     | CVSS base score threshold     | `0`     |
+| `scan-cvss-temporal-threshold` | CVSS temporal score threshold | `0`     |
+
+> [!Note]
+>
+> Specifying either a base or temporal threshold will change the pull request
+> comments to split the vulnerabilities into two sections, the first will be
+> results found above the threshold and the second will be results found below.