From 052eedc624f3d13e59be498ac7b90c98804017bd Mon Sep 17 00:00:00 2001
From: Vishwajit Nagulkar
 <119565952+VishwajitNagulkar@users.noreply.github.com>
Date: Fri, 6 Sep 2024 16:03:31 +0530
Subject: [PATCH] feat: update readme.yaml (#15)

---
 README.md   | 125 ----------------------------------------------------
 README.yaml |  64 +++++++++++----------------
 2 files changed, 25 insertions(+), 164 deletions(-)
 delete mode 100644 README.md

diff --git a/README.md b/README.md
deleted file mode 100644
index ad9fd7c..0000000
--- a/README.md
+++ /dev/null
@@ -1,125 +0,0 @@
-<!-- This file was automatically generated by the `geine`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. -->
-[![Banner](https://github.com/clouddrove/terraform-module-template/assets/119565952/67a8a1af-2eb7-40b7-ae07-c94cde9ce062)][website]
-<h1 align="center">
-    Terraform AZURE LOG-ANALYTICS
-</h1>
-
-<p align="center" style="font-size: 1.2rem;">
-    With our comprehensive DevOps toolkit - streamline operations, automate workflows, enhance collaboration and, most importantly, deploy with confidence.
-</p>
-
-
-<p align="center">
-
-<a href="https://www.terraform.io">
-  <img src="https://img.shields.io/badge/Terraform-v1.1.7-green" alt="Terraform">
-</a>
-<a href="https://github.com/clouddrove/terraform-azure-log-analytics/actions/workflows/tfsec.yml">
-  <img src="https://github.com/clouddrove/terraform-azure-log-analytics/actions/workflows/tfsec.yml/badge.svg" alt="tfsec">
-</a>
-<a href="LICENSE.md">
-  <img src="https://img.shields.io/badge/License-APACHE-blue.svg" alt="Licence">
-</a>
-<a href="CHANGELOG.md">
-  <img src="https://img.shields.io/badge/Changelog-blue" alt="Changelog">
-</a>
-
-
-</p>
-<p align="center">
-
-<a href='https://facebook.com/sharer/sharer.php?u=https://github.com/clouddrove/terraform-azure-log-analytics'>
-  <img title="Share on Facebook" src="https://user-images.githubusercontent.com/50652676/62817743-4f64cb80-bb59-11e9-90c7-b057252ded50.png" />
-</a>
-<a href='https://www.instagram.com/cloud_drove?igsh=cHJqaDY3bGtnYmh3' title="Follow On Instagram">
-  <img src="https://github.com/gauravghongde/social-icons/blob/master/SVG/Color/Instagram.svg" width="23" height="23" />
-</a>
-<a href='https://www.linkedin.com/shareArticle?mini=true&title=Terraform+AZURE+LOG-ANALYTICS&url=https://github.com/clouddrove/terraform-azure-log-analytics'>
-  <img title="Share on LinkedIn" src="https://user-images.githubusercontent.com/50652676/62817742-4e339e80-bb59-11e9-87b9-a1f68cae1049.png" />
-</a>
-<a href='https://twitter.com/intent/tweet/?text=Terraform+AZURE+LOG-ANALYTICS&url=https://github.com/clouddrove/terraform-azure-log-analytics'>
-  <img title="Share on Twitter" src="https://user-images.githubusercontent.com/50652676/62817740-4c69db00-bb59-11e9-8a79-3580fbbf6d5c.png" />
-</a>
-
-</p>
-<hr>
-
-
-
-
-
-## Prerequisites and Providers
-
-This table contains both Prerequisites and Providers:
-
-| Description   | Name                                       | Version   |
-|:-------------:|:-------------------------------------------:|:---------:|
-| **Prerequisite** | [Terraform](https://learn.hashicorp.com/terraform/getting-started/install.html) | >= 1.7.8 |
-| **Provider** | [azure](https://azure.microsoft.com/) | >= 3.39.0 |
-
-
-
-
-
-
-
-
-<!-- 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-## Feedback 
-Spot a bug or have thoughts to share with us? Let's squash it together! Log it in our [issue tracker](https://github.com/clouddrove/terraform-azure-log-analytics/issues), feel free to drop us an email at [hello@clouddrove.com](mailto:hello@clouddrove.com).
-
-Show some love with a ★ on [our GitHub](https://github.com/clouddrove/terraform-azure-log-analytics)!  if our work has brightened your day! – your feedback fuels our journey!
-
-
-
-
-## Join Our Slack Community
-
-Join our vibrant open-source slack community and embark on an ever-evolving journey with CloudDrove; helping you in moving upwards in your career path.
-Join our vibrant Open Source Slack Community and embark on a learning journey with CloudDrove. Grow with us in the world of DevOps and set your career on a path of consistency.
-
-🌐💬What you'll get after joining this Slack community:
-
-- 🚀 Encouragement to upgrade your best version.
-- 🌈 Learning companionship with our DevOps squad.
-- 🌱 Relentless growth with daily updates on new advancements in technologies.
-
-Join our tech elites [Join Now][slack] 🚀
-
-
-## Explore Our Blogs
-
- Click [here][blog] :books: :star2:
-
-## Tap into our capabilities
-We provide a platform for organizations to engage with experienced top-tier DevOps & Cloud services. Tap into our pool of certified engineers and architects to elevate your DevOps and Cloud Solutions. 
-
-At [CloudDrove][website], has extensive experience in designing, building & migrating environments, securing, consulting, monitoring, optimizing, automating, and maintaining complex and large modern systems. With remarkable client footprints in American & European corridors, our certified architects & engineers are ready to serve you as per your requirements & schedule. Write to us at [business@clouddrove.com](mailto:business@clouddrove.com).
-
-<p align="center">We are <b> The Cloud Experts!</b></p>
-<hr />
-<p align="center">We ❤️  <a href="https://github.com/clouddrove">Open Source</a> and you can check out <a href="https://registry.terraform.io/namespaces/clouddrove">our other modules</a> to get help with your new Cloud ideas.</p>
-
-  [website]: https://clouddrove.com
-  [blog]: https://blog.clouddrove.com
-  [slack]: https://www.launchpass.com/devops-talks
-  [github]: https://github.com/clouddrove
-  [linkedin]: https://cpco.io/linkedin
-  [twitter]: https://twitter.com/clouddrove/
-  [email]: https://clouddrove.com/contact-us.html
-  [terraform_modules]: https://github.com/clouddrove?utf8=%E2%9C%93&q=terraform-&type=&language=
diff --git a/README.yaml b/README.yaml
index 27760e0..33b9044 100644
--- 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 = ""
     }
   ```
+  
+  
\ No newline at end of file