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 VPC

# License of this project
license: "APACHE"

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

# 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"

prerequesties:
  - name: Terraform 1.4.6
    url: https://learn.hashicorp.com/terraform/getting-started/install.html
#  description of this project
description: |-
  VPCs are virtual networks containing resources that can communicate with each other in full isolation, using private IP addresses.

# 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 "vpc" {
        source            = "terraform-do-modules/vpc/digitalocean"
        version           = "1.0.0"
        name              = "app"
        environment       = "test"
        ip_range          = "10.0.0.0/16"
        region            = "blr1"
      }
  ```