Expanded READMEs.

.circleci/config.yml

@@ -15,10 +15,10 @@ jobs:
           command: ./tflint --deep --aws-region us-east-1
       - run:
           name: Run terraform init
-          command: terraform init -input=false tests/integration
+          command: terraform init -input=false test/integration
       - run:
           name: Run terraform plan
-          command: terraform plan -out=tfplan -input=false tests/integration
+          command: terraform plan -out=tfplan -input=false test/integration
       - persist_to_workspace:
           root: .
           paths:

README.md

@@ -1,7 +1,7 @@
 # AWS Office 365 Route53 Terraform Module
 
 [![CircleCI](https://circleci.com/gh/tiguard/terraform-aws-route53-o365.svg?style=shield)](https://circleci.com/gh/tiguard/terraform-aws-route53-o365)
-[![GitHub release](https://img.shields.io/github/release/tiguard/terraform-aws-route53-o365.svg?style=flat-square)](https://github.com/tiguard/terraform-aws-route53-o365)
+[![GitHub release](https://img.shields.io/github/release/tiguard/terraform-aws-route53-o365.svg?style=flat-square)](https://github.com/tiguard/terraform-aws-route53-o365/releases)
 [![license](https://img.shields.io/github/license/tiguard/terraform-aws-route53-o365.svg?style=flat-square)](https://github.com/tiguard/terraform-aws-route53-o365/blob/master/LICENSE.md)
 
 A terraform module which creates, in AWS Route53, the [DNS records](https://support.office.com/article/External-Domain-Name-System-records-for-Office-365-c0531a6f-9e25-4f2d-ad0e-a70bfef09ac0) required by Office 365.

examples/existing-zone/README.md

@@ -0,0 +1,20 @@
+# Using the module with an existing Route53 zone
+
+If you already have a Route53 hosted zone for the domain, the `aws_route53_zone` data source should be used to find the zone ID.
+
+```hcl
+data "aws_route53_zone" "zone" {
+    name = "example.com."
+}
+
+module "route53_o365" {
+    source = "tiguard/route53-o365/aws"
+
+    domain          = "example.com"
+    zone_id         = "${data.aws_route53_zone.zone.zone_id}"
+    ms_txt          = "ms12345678"
+    enable_exchange = true
+    enable_sfb      = true
+    enable_mdm      = true
+}
+```

examples/new-zone/README.md

@@ -0,0 +1,20 @@
+# Using the module with a new Route53 zone
+
+If you're creating a new Route53 hosted zone for the domain, the `aws_route53_zone` resource can pass the new zone ID to the module.
+
+```hcl
+resource "aws_route53_zone" "zone" {
+    name = "example.com"
+}
+
+module "route53_o365" {
+    source = "tiguard/route53-o365/aws"
+
+    domain          = "example.com"
+    zone_id         = "${aws_route53_zone.zone.zone_id}"
+    ms_txt          = "ms12345678"
+    enable_exchange = true
+    enable_sfb      = true
+    enable_mdm      = true
+}
+```

outputs.tf

@@ -1,3 +1,4 @@
 output "mx_record" {
-    value = "${replace("${data.template_file.mx_record.rendered}", "/^10./", "")}"
+    description = "The DNS name of the specific Office 365 mail server for the domain."
+    value       = "${replace("${data.template_file.mx_record.rendered}", "/^10./", "")}"
 }