feat: update readme.yaml (#15)

clouddrove · Sep 6, 2024 · 052eedc · 052eedc
1 parent ff64e74
commit 052eedc
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 164 deletions.
diff --git a/README.md b/README.md
diff --git a/README.yaml b/README.yaml
@@ -4,9 +4,8 @@
 # Run `make readme` to rebuild the `README.md`
 #
 
-
 # Name of this project
-name: Terraform AZURE LOG-ANALYTICS
+name : Terraform AZURE LOG-ANALYTICS
 
 # License of this project
 license: "APACHE"
@@ -16,54 +15,41 @@ github_repo: clouddrove/terraform-azure-log-analytics
 
 # Badges to display
 badges:
-  - name: "Terraform"
-    image: "https://img.shields.io/badge/Terraform-v1.1.7-green"
-    url: "https://www.terraform.io"
+  - name: "Latest Release"
+    image: "https://img.shields.io/github/release/clouddrove/terraform-azure-log-analytics.svg"
+    url: "https://github.com/clouddrove/terraform-azure-log-analytics/releases/latest"
   - name: "tfsec"
     image: "https://github.com/clouddrove/terraform-azure-log-analytics/actions/workflows/tfsec.yml/badge.svg"
     url: "https://github.com/clouddrove/terraform-azure-log-analytics/actions/workflows/tfsec.yml"
   - name: "Licence"
     image: "https://img.shields.io/badge/License-APACHE-blue.svg"
     url: "LICENSE.md"
-  - name: "Changelog"
-    image: "https://img.shields.io/badge/Changelog-blue"
-    url: "CHANGELOG.md"
-
-# Prerequesties to display
-prerequesties:
-  - name: Terraform
-    url: https://learn.hashicorp.com/terraform/getting-started/install.html
-    version: ">= 1.7.8"
-
-providers:
-  - name: azure
-    url: https://azure.microsoft.com/
-    version: ">= 3.39.0"
-
-module_dependencies:
-  - name: Labels Module
-    url: https://github.com/clouddrove/terraform-azure-labels
-    description: Provides resource tagging.
 
 #  description of this project
 description: |-
-  Terraform module to create LOG-ANALYTICS resource on AZURE.
+  Terraform module to create log-analytics resource on AZURE.
+# extra content
+include:
+  - "terraform.md"
 
 # How to use this project
-# yamllint disable rule:line-length
-usage : |-
-  ### Simple Example
-  Here is an example of how you can use this module in your inventory structure:
+usage: |-
+  Here are some examples of how you can use this module in your inventory structure:
   ```hcl
-  module "log-analytics" {
-  source                           = "clouddrove/log-analytics/azure"
-  name                             = "app"
-  environment                      = "test"
-  label_order                      = ["name", "environment"]
-  resource_group_name              = module.resource_group.resource_group_name
-  log_analytics_workspace_location = module.resource_group.resource_group_location
-
-  #### diagnostic setting
-  log_analytics_workspace_id       = module.log-analytics.workspace_id
+    module "log-analytics" {
+    source               = "clouddrove/log-analytics/azure"
+    version              = "1.0.0"
+    name                 = "app"
+    environment          = "test"
+    resource_group_name  = module.resource_group.resource_group_name
+    location             = module.resource_group.resource_group_location
+    virtual_network_name = module.vnet.vnet_name[0]
+    subnet_id            = module.name_specific_subnet.specific_subnet_id[0]
+
+    #### enable diagnostic setting
+    diagnostic_setting_enable  = true
+    log_analytics_workspace_id = ""
     }
   ```
+  
+