Update README.md

terraform-trailwatch-modules · Oct 30, 2024 · 52140ed · 52140ed
1 parent 8256f1c
commit 52140ed
Showing 1 changed file with 16 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,15 @@
-# aws-monitoring-sg
+<p align="center">
+  <a href="https://github.com/terraform-trailwatch-modules" title="Terraform Trailwatch Modules"><img src="https://raw.githubusercontent.com/terraform-trailwatch-modules/art/refs/heads/main/logo.jpg" height="100" alt="Terraform Trailwatch Modules"></a>
+</p>
+
+<h1 align="center">Security Group</h1>
+
+<p align="center">
+  <a href="https://github.com/terraform-trailwatch-modules/terraform-trailwatch-security-groups/releases" title="Releases"><img src="https://img.shields.io/badge/Release-1.0.1-1d1d1d?style=for-the-badge" alt="Releases"></a>
+  <a href="https://github.com/terraform-trailwatch-modules/terraform-trailwatch-security-groups/blob/main/LICENSE" title="License"><img src="https://img.shields.io/badge/License-MIT-1d1d1d?style=for-the-badge" alt="License"></a>
+</p>
+
+## About
 This Terraform module creates CloudWatch Log Metric Filters and associated Alarms for monitoring Security Groups (SGs) based on specified event names. It helps ensure that critical changes to SGs are monitored effectively and alerts are sent to a pre-existing SNS topic.
 
 ## Features
@@ -27,8 +38,8 @@ This Terraform module creates CloudWatch Log Metric Filters and associated Alarm
 
 ## Simple Example
 ```hcl
-module "aws_monitoring_sg" {
-  source                         = "path/to/module"
+module "terraform_trailwatch_sg" {
+  source                         = "terraform-trailwatch-modules/security-groups/trailwatch"
   sg_ids                         = ["sg-12345678", "sg-87654321"]
   cw_log_group_name              = "the-cloudtrail-log-group"
   cw_metric_filter_alarm_actions = ["arn:aws:sns:region:account-id:sns-topic"]
@@ -37,8 +48,8 @@ module "aws_monitoring_sg" {
 
 ## Advanced Example
 ```hcl
-module "aws_monitoring_sg" {
-  source                                     = "path/to/module"
+module "terraform_trailwatch_sg" {
+  source                                     = "terraform-trailwatch-modules/security-groups/trailwatch"
   sg_ids                                     = ["sg-12345678", "sg-87654321"]
   sg_event_names                             = ["DeleteSecurityGroup", "AuthorizeSecurityGroupIngress"]
   cw_log_group_name                          = "the-cloudtrail-log-group"