Update README.md (#38)

<!--
Thank you for proposing a pull request! Please note that SOME TESTS WILL
LIKELY FAIL due to how GitHub exposes secrets in Pull Requests from
forks.
Someone from the team will review your Pull Request and respond.

Please describe your change and any implementation details below.
-->

---------

Signed-off-by: pankhurisaxena28 <[email protected]>
Co-authored-by: Seth Vargo <[email protected]>

Author: pankhurisaxena28

README.md

@@ -21,9 +21,10 @@ Cloud product, please contact [Google Cloud
 support](https://cloud.google.com/support).**
 
 > [!IMPORTANT]
-> This is a Security Command Center Premium tier offering for subscription customers only. You must activate the Security Command Center Premium tier in the Google Cloud organization to use this feature.
->
-> This offering is covered by the Pre-GA Offerings Terms of the Google Cloud Terms of Service.
+> This action requires the Security Command Center Premium tier or Enterprise 
+> tier. In the Premium tier, you must be a subscription customer to use this 
+> action. You must activate Security Command Center at the organization level to
+> use this feature.
 
 > [!CAUTION]
 > Don’t enter any sensitive information such as passwords and other personal identifiable information in the Terraform plan files.
@@ -136,12 +137,12 @@ jobs:
 -   `iac_scan_result`: The result of the security scan. One of:
 
     - `passed`: No violations were found or the `failure_criteria` was not
-    satisfied.
+      satisfied.
 
     - `failed`: The `failure_criteria` was satisfied.
 
     - `error`: The action ran into an execution error, generally due to a
-    misconfiguration or invalid credentials.
+      misconfiguration or invalid credentials.
 
 -   `iac_scan_result_sarif_path`: Path for the SARIF report file. This file is only available when
     violations are found in the scan file.
@@ -159,22 +160,22 @@ to authenticate the action. You can use [Workload Identity Federation][wif] or
 
 ```yaml
 jobs:
- job_id:
-   permissions:
-     contents: 'read'
-     id-token: 'write'
+  job_id:
+    permissions:
+      contents: 'read'
+      id-token: 'write'
 
 
-   steps:
-   - id: 'auth'
-     uses: 'google-github-actions/auth@v2'
-     with:
-       workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider'
-       service_account: '[email protected]'
+    steps:
+    - id: 'auth'
+      uses: 'google-github-actions/auth@v2'
+      with:
+        workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider'
+        service_account: '[email protected]'
 
 
-   - id: 'analyze-code-security-scc'
-     uses: 'google-github-actions/analyze-code-security-scc@v0'
+    - id: 'analyze-code-security-scc'
+      uses: 'google-github-actions/analyze-code-security-scc@v0'
 ```
 
 

action.yml

@@ -21,7 +21,7 @@ inputs:
   organization_id:
     description: |-
       Google Cloud organization ID for the organization which includes the
-      resources that you want to modify.
+      resources that you want to modify. For example, '1234'.
     required: true
 
   scan_file_ref:
@@ -38,37 +38,43 @@ inputs:
 
   iac_type:
     description: |-
-      IaC template type. Currently only `terraform` is supported.
+      The IaC template type. Currently only Terraform is supported.
     default: 'terraform'
     required: true
 
   scan_timeout:
     description: |-
-      Maximum time before the scanning stops. This is specified as a time
-      duration value, such as "1m" or "5s". The value must be between "1m" and
-      "10m".
-    default: '1m'
+      The maximum time before the scanning stops. The value must be between "1m"
+      and `10m`.
+    default: '3m'
     required: false
 
   ignore_violations:
     description: |-
       Whether violations found in IaC file should be ignored when determining
-      the build status. This input does not apply to violations that are related
+      the build status. This input doesn't apply to violations that are related
       to generating SARIF reports and determining the `iac_scan_result`.
     default: false
     required: false
 
   failure_criteria:
     description: |-
-      Ffailure criteria that determines the workflow build status. You can set a
-      threshold for the number of critical, high, medium, and low severity
+      The failure criteria that determines the workflow build status. You can
+      set a threshold for the number of critical, high, medium, and low severity
       issues and use an aggregator (either `and` or `or`) to evaluate the
       criteria.
 
       To determine whether a build has failed, the threshold for each severity
       is evaluated against the count of issues with that severity in the IaC
       scan results and then severity level evaluations are aggregated using
-      `AND` or `OR` to arrive at `failure_criteria` value.
+      `AND` or `OR` to arrive at `failure_criteria` value. You must include an
+      aggregator in the string. The aggregator value is case-sensitive.
+
+      For example, if you set the failure criteria to `HIGH:1,LOW:1,OPERATOR:OR`,
+      the workflow fails if there is 1 or more HIGH severity findings or 1 or
+      more LOW severity findings. If you set the failure criteria to
+      `HIGH:1,LOW:1,OPERATOR:AND`, the workflow fails if there is 1 or more HIGH
+      severity findings and 1 or more LOW severity findings.
 
       If the `failure_criteria` evaluates to `true`, the workflow is marked as
       `FAILED`. Otherwise, the workflow is marked as `SUCCESS`.