From 845bac236cee351414e5e77afb943ec0c43252ab Mon Sep 17 00:00:00 2001
From: Manu <manuchn@amazon.com>
Date: Tue, 22 Aug 2023 18:27:41 -0400
Subject: [PATCH] docs: Updated Readme

---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/README.md b/README.md
index ccd3d11..b8e9e60 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,45 @@
 # conformity-tf-scanner
 Terraform template scanner using Conformity API
+
+Conformity template scanner accepts CloudFormation templates, in either YAML or JSON format, and Terraform plan templates only in JSON format. 
+
+
+## Pre-requisites
+
+- You have a Cloud Conformity API key
+- You have an AWS account with GitHub actions configured to assume role. We are not using this role to provision any resources, but required for Terraform plan stage.
+
+
+## Output
+
+The python script reviews the generated Terraform plan against the conformity api to provide you a categorized output of rules , their risk levels and status.
+The script is further configured to fail with an exit code of 1 in case of high or Very_high findings. This can be configured as needed.
+
+```bash
+
+{
+  "DNS Compliant S3 Bucket Names": {
+    "risk": "LOW",
+    "status": "SUCCESS"
+  },
+  "Enable S3 Block Public Access for S3 Buckets": {
+    "risk": "MEDIUM",
+    "status": "FAILURE"
+  },
+  .....
+  "Secure Transport": {
+    "risk": "MEDIUM",
+    "status": "FAILURE"
+  },
+  "Server Side Encryption": {
+    "risk": "HIGH",
+    "status": "FAILURE"
+  },
+  "Tags": {
+    "risk": "LOW",
+    "status": "FAILURE"
+  }
+}
+{'VERY_HIGH': 10, 'MEDIUM': 3, 'LOW': 7, 'HIGH': 1}
+
+```
\ No newline at end of file