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 Labels

# License of this project
license: "MIT"

# Canonical GitHub repo
github_repo: clouddrove/terraform-lables

# Badges to display
badges:
  - name: "Terraform"
    image: "https://img.shields.io/badge/terraform-v0.14-green"
    url: "https://www.terraform.io"
  - name: "Licence"
    image: "https://img.shields.io/badge/License-MIT-blue.svg"
    url: "LICENSE.md"

#  description of this project
description: |-
  This terraform module is designed to generate consistent label names and tags for resources. You can use terraform-labels to implement a strict naming convention.

# extra content
include:
 - "terraform.md"

# How to use this project
usage : |-
  ### Simple Example
  Here is an example of how you can use this module in your inventory structure:
  ```hcl
      module "label" {
            source      = "git::https://github.com/clouddrove/terraform-labels.git?ref=tags/0.15.0"
            name        = "labels"
            environment = "prod"
            managedby   = "hello@clouddrove.com"
            repository  = "https://github.com/clouddrove/terraform-labels"
            label_order = ["name","attributes","environment"]
            delimiter   = "-"
        tags = {
            "Terraform Version"   = "0.15.0"
            "created_date"        = "4-Apr-21"
        }
     }
  ```