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 Container Registry

# License of this project
license: "APACHE"

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

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/terraform-do-modules/terraform-digitalocean-container-registry.svg"
    url: "https://github.com/terraform-do-modules/terraform-digitalocean-container-registry/releases/latest"
  - name: "tfsec"
    image: "https://github.com/terraform-do-modules/terraform-digitalocean-container-registry/actions/workflows/tfsec.yml/badge.svg"
    url: "https://github.com/terraform-do-modules/terraform-digitalocean-container-registry/actions/workflows/tfsec.yml"
  - name: "Terraform"
    image: "https://img.shields.io/badge/Terraform-v1.4.6-green"
    url: "https://www.terraform.io"
  - name: "Licence"
    image: "https://img.shields.io/badge/License-APACHE-blue.svg"
    url: "LICENSE.md"

prerequesties:
  - name: Terraform 1.4.6
    url: https://learn.hashicorp.com/terraform/getting-started/install.html

#  description of this project
description: |-
  Terraform module to create Digitalocean container registry service resource on Digitalocean.
# 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 "container-registry" {
        source                 = "terraform-do-modules/container-registry/digitalocean"
        version                = "1.0.0"
        name                   = local.name
        environment            = local.environment
        region                 = local.region
        subscription_tier_slug = "starter"
      }
  ```