From 6ac79af08a1a5d698f77f93df59f1ff2102e25e5 Mon Sep 17 00:00:00 2001
From: Erin Atkinson <20285458+erindatkinson@users.noreply.github.com>
Date: Wed, 4 Sep 2019 09:45:41 -0600
Subject: [PATCH] move tf to md and add copy for correct display (#6)

Signed-off-by: Erin Atkinson <20285458+erindatkinson@users.noreply.github.com>
---
 examples/basic/{main.tf => README.md} | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)
 rename examples/basic/{main.tf => README.md} (57%)

diff --git a/examples/basic/main.tf b/examples/basic/README.md
similarity index 57%
rename from examples/basic/main.tf
rename to examples/basic/README.md
index 4614c190..9dfab6d7 100644
--- a/examples/basic/main.tf
+++ b/examples/basic/README.md
@@ -1,3 +1,25 @@
+# Terraform Enterprise: High Availability - Basic example
+
+This is a basic example of how to set up the configurations to use this module. Please see the [inputs page](https://registry.terraform.io/modules/terraform-enterprise/azurerm/0.0.2-beta?tab=inputs) for more details on usage.
+
+## Resources
+
+This example assumes you have an existing
+
+* Resource Group
+* Virtual Network
+* Subnet with attached Network Security Group
+* Azure Hosted Domain within the Resource Group
+  * PKCS12 Certificate for the domain
+* Azure Key Vault within the Resource Group
+
+## Usage
+
+To use this example, copy the configs to a `main.tf` file in an empty directory on a computer that has API access to Azure (Local computer or server with access), fill in the local variables as well as the `existing-` prefixed parameters and any optional parameters to the module with your configurations and run terraform init, plan, and apply, once the apply has completed, wait for the application to load as the installer dashboard url will be included in the `tfe_cluster` output map.
+
+## Example
+
+```hcl
 locals {
   license_file = "/path/to/licence/file.rli"
   cert_file    = "/path/to/domain/certificate.pfx"
@@ -15,7 +37,7 @@ provider "azurerm" {
 
 module "tfe_cluster" {
   source  = "hashicorp/tfe-ha/azure"
-  version = "0.0.1-beta"
+  version = "0.0.2-beta"
 
   license_file                 = "${local.license_file}"
   resource_group_name          = "existing-rg-name"
@@ -39,3 +61,4 @@ output "tfe_cluster" {
     ssh_private_key              = "${module.tfe_cluster.ssh_private_key}"
   }
 }
+```