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: "APACHE"

# Canonical GitHub repo
github_repo: clouddrove/terraform-aws-labels

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/clouddrove/terraform-aws-labels.svg"
    url: "https://github.com/clouddrove/terraform-aws-labels/releases/latest"
  - name: "tfsec"
    image: "https://github.com/clouddrove/terraform-aws-labels/actions/workflows/tfsec.yml/badge.svg"
    url: "https://github.com/clouddrove/terraform-aws-labels/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:
  - name: Terraform
    url: https://learn.hashicorp.com/terraform/getting-started/install.html
    version: ">= 1.6.6"

providers:
  - name: aws
    url: https://aws.amazon.com/
    version: ">= 5.31.0"

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.

# 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      = "clouddrove/labels/aws"
        version     = "1.3.0"
        enabled     = true
        name        = "labels"
        environment = "prod"
        managedby   = "hello@clouddrove.com"
        repository  = "https://github.com/clouddrove/terraform-labels"
        label_order = ["name","attributes","environment"]
        delimiter   = "-"
        tags = {
            "Terraform Version"   = "1.0.1"
            "created_date"        = "4-Apr-21"
        }
     }
  ```