From c05eefb4a0c1695e240bc15e27a621d2d2ba2835 Mon Sep 17 00:00:00 2001
From: "Tobias R." <tobias.rohrle@theodo.com>
Date: Sat, 7 Dec 2024 00:24:09 +0100
Subject: [PATCH] improved documentation about guacamole-ignore

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

diff --git a/README.md b/README.md
index d633f171..61923199 100644
--- a/README.md
+++ b/README.md
@@ -63,6 +63,25 @@ Three modes currently exist :
 
 A verbose mode (`-v`) exists to add more information to the output.
 
+**Skipping individual checks**
+
+You can use inline code comments to skip individual checks for a particular resource.
+
+To skip a check on a given Terraform definition block resource, apply the following comment pattern inside its scope: `# guacamole-ignore:<check_id> <suppression_comment>`
+
+    <check_id> is one of the available check scanners.
+    <suppression_comment> is an optional suppression reason.
+
+Example:
+
+The following comment skips the `TF_NAM_001` check on the resource identified by `network`
+
+```bash
+# guacamole-ignore:TF_NAM_001 We will be creating more rg
+resource "azurerm_resource_group" "network" {
+  name...
+```
+
 ## List of checks
 
 ### Static module check for Terraform