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 AWS Lightsail

# License of this project
license: "MIT"

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

# 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-MIT-blue.svg"
    url: "LICENSE.md"

#  description of this project
description: |-
  Terraform module to create Lightsail instance, Lightsail Key Pair
  (Optional), Lightsail Static IP (Optional).

# 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 "lightsail" {
        source        = "clouddrove/lightsail/aws"
        version       = "0.15.0"
        environment   = "test"
        name          = "lightsail"
        key_pair_name = "testing"
        label_order   = ["name", "environment"]
     }
  ```