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 Module Template

# License of this project
license: "APACHE"

# Canonical GitHub repo
github_repo: clouddrove/terraform-module-template

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/clouddrove/terraform-aws-control-tower.svg"
    url: "https://github.com/clouddrove/terraform-aws-control-tower/releases/latest"
  - name: "tfsec"
    image: "https://github.com/clouddrove/terraform-aws-control-tower/actions/workflows/tfsec.yml/badge.svg"
    url: "https://github.com/clouddrove/terraform-aws-control-tower/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"

module_dependencies:
  - name: AWS VPC Module
    url: https://github.com/clouddrove/terraform-aws-vpc.git
    description: Provides VPC resorces.
  - name: AWS Subnet Module
    url: https://github.com/clouddrove/terraform-aws-subnet.git
    description: Provides Subnet Resorces.
  - name: AWS Security Group Module
    url: https://github.com/clouddrove/terraform-aws-security-group.git
    description: Provides security group resources.
    
#  description of this project
description: |-
  Terraform module template to create new modules using this as baseline

# How to use this project
# How to use this project
usage: |-
  Here are some examples of how you can use this module in your inventory structure:
  ```hcl
    ```