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 DigitalOcean Labels

# License of this project
license: "APACHE"

# Canonical GitHub repo
github_repo: terraform-do-modules/terraform-digitalocean-labels

# Badges to display
badges:
  - name: "Terraform"
    image: "https://img.shields.io/badge/Terraform-v0.15-green"
    url: "https://www.terraform.io"
  - name: "Licence"
    image: "https://img.shields.io/badge/License-APACHE-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 : |-
  ### Example
  Here is an example of how you can use this module in your inventory structure:
  ```hcl
      module "labels" {
      source      = "terraform-do-modules/labels/digitalocean"
      version     = "1.0.1"
      name        = "labels"
      environment = "test"
      label_order = ["name", "environment"]
      attributes  = ["private"]
      }
  ```