Merge pull request #52 from meltwater/hikerspath-patch-1

Proper Source Example in Readme

CHANGELOG.md

@@ -8,14 +8,24 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ### Added
 
-## [v2.1.5](https://github.com/meltwater/terraform-aws-asg-dns-handler/compare/v2.1.4...v2.1.5) - 2022-03-22
+## [v2.1.7](https://github.com/meltwater/terraform-aws-asg-dns-handler/compare/v2.1.6...v2.1.7) - 2022-03-22
 
-- Updated Source Reference on the README.md for the Private Registry on app.terraform.io
+### Changed
 
-- [#46](https://github.com/meltwater/terraform-aws-asg-dns-handler/pull/46) Create CHANGELOG.md
+- Updated readme for proper module calls from public registry
+
+
+## [v2.1.6](https://github.com/meltwater/terraform-aws-asg-dns-handler/compare/v2.1.5...v2.1.6) - 2022-03-22
 
+### Changed
+
+- Updated readme
+
+## [v2.1.5](https://github.com/meltwater/terraform-aws-asg-dns-handler/compare/v2.1.4...v2.1.5) - 2022-03-22
 
+- Updated Source Reference on the README.md for the Private Registry on app.terraform.io
 
+- [#46](https://github.com/meltwater/terraform-aws-asg-dns-handler/pull/46) Create CHANGELOG.md
 
 ## [v2.1.4](https://github.com/meltwater/terraform-aws-asg-dns-handler/compare/v2.1.3...v2.1.4) - 2022-03-04
 

README.md

@@ -1,19 +1,19 @@
-[![Build Status](https://cloud.drone.io/api/badges/meltwater/terraform-aws-asg-dns-handler/status.svg)](https://cloud.drone.io/meltwater/terraform-aws-asg-dns-handler)
-
-# ASG DNS handler
-
-## Purpose
+# ASG DNS handler | [![Build Status](https://cloud.drone.io/api/badges/meltwater/terraform-aws-asg-dns-handler/status.svg)](https://cloud.drone.io/meltwater/terraform-aws-asg-dns-handler)
 
 This Terraform module sets up everything necessary for dynamically setting hostnames following a certain pattern on instances spawned by AWS Auto Scaling Groups (ASGs).
 
 Learn more about our motivation to build this module in our blog post [Dynamic Route53 records for AWS Auto Scaling Groups with Terraform](https://underthehood.meltwater.com/blog/2020/02/07/dynamic-route53-records-for-aws-auto-scaling-groups-with-terraform/).
 
+## Maintainers
+
+This repository and the module it houses are maintained Foundation Missions A-Team.  Should you encounter issues or require changes to code maintained in this repository, please reachout through an issue that is part of this project.
+
 ## Requirements
 
-- [Terraform](https://www.terraform.io/downloads.html) 0.12+
-- [Terraform AWS provider](https://github.com/terraform-providers/terraform-provider-aws) 2.0+
+- [Terraform](https://www.terraform.io/downloads.html) 0.12+ and [Terraform AWS provider](https://github.com/terraform-providers/terraform-provider-aws) 2.0+ use v2+ releases
+- [Terraform](https://www.terraform.io/downloads.html) 0.11 and below, [Terraform AWS provider](https://github.com/terraform-providers/terraform-provider-aws) 2.0.14 and below use v1.x releases
 
-## Usage
+## How do I use it?
 
 Create an ASG and set the `asg:hostname_pattern` tag for example like this:
 
@@ -36,8 +36,9 @@ tag {
 Once you have your ASG set up, you can just invoke this module and point to it:
 ```hcl
 module "clever_name_autoscale_dns" {
-  source  = registry.terraform.io/modules/meltwater/asg-dns-handler/aws/latest"
-  version = "2.1.6"
+  source  = meltwater/asg-dns-handler/aws"
+  version = "~> 2.0"
+  
   # use_public_ip = true
   autoscale_handler_unique_identifier = "clever_name"
   autoscale_route53zone_arn           = "ABCDEFGHIJ123"
@@ -113,16 +114,16 @@ resource "aws_autoscaling_group" "my_asg" {
 }
 
 module "autoscale_dns" {
-  source  = registry.terraform.io/modules/meltwater/asg-dns-handler/aws/latest"
-  version = "2.1.6"
+  source  = "meltwater/asg-dns-handler/aws"
+  version = "2.1.7"
 
   autoscale_handler_unique_identifier = "my_asg_handler"
   autoscale_route53zone_arn           = var.internal_zone_id
   vpc_name                            = var.vpc_name
 }
 ```
 
-## Contributing
+## Developers Guide / Contributing
 
 Please read [CONTRIBUTING.md](CONTRIBUTING.md) to understand how to submit pull requests to us, and also see our [Code of Conduct](CODE_OF_CONDUCT.md).