README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#


# Name of this project
name: Terraform AZURE RESOURCE-GROUP

# License of this project
license: "APACHE"

# Canonical GitHub repo
github_repo: clouddrove/terraform-azure-resource-group

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/clouddrove/terraform-azure-resource-group.svg"
    url: "https://github.com/clouddrove/terraform-azure-resource-group/releases/latest"
  - name: "tfsec"
    image: "https://github.com/clouddrove/terraform-azure-resource-group/actions/workflows/tfsec.yml/badge.svg"
    url: "https://github.com/clouddrove/terraform-azure-resource-group/actions/workflows/tfsec.yml"
  - name: "Licence"
    image: "https://img.shields.io/badge/License-APACHE-blue.svg"
    url: "LICENSE.md"

#  description of this project
description: |-
  Terraform module to create RESOURCE-GROUP 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:
   ```hcl
      module "resource_group" {
      source      = "terraform/resource-group/azure"
      version     = "1.0.0"
      name        = "example"
      environment = "test"
      location    = "North Europe"

       #resource lock
      resource_lock_enabled = true
      lock_level            = "CanNotDelete"
     }
  ```