Improving doc

Author: Steven Nemetz

README.md

@@ -2,12 +2,64 @@
 
 Terraform module to provide consistent label names and tags for resources.
 
-A single name format will not solve every use case, so multiple variants are returned and there is a few options to affect how they get build. The general name convention is `{organization}-{environment}-{name}-{attributes}`. `Name` is required, the other 3 can be turned on/off indivisually. The delimiter (`-`) can be changed
+A single name format will not solve every use case, so multiple variants are returned and there is a few options to affect how they get build. The general name convention is `{organization}-{environment}-{name}-{attributes}`. `Name` is required, the other 3 can be turned on/off individually. The delimiter (`-`) can be changed
 
 All [devops-workflow](https://registry.terraform.io/search?q=devops-workflow&verified=false) modules will eventually use this.
 
 **NOTE:** `local` refers to this using [locals](https://www.terraform.io/docs/configuration/locals.html) and does not create any resources. It just builds new variables.
 
 Terraform registry: https://registry.terraform.io/modules/devops-workflow/label/local
 
-## TODO: Add usage/examples
+## Usage:
+
+### Basic Example
+
+```hcl
+module "name" {
+  source        = "devops-workflow/label/local"
+  version       = "0.1.2"
+  name          = "name"
+  environment   = "qa"
+}
+```
+This will create an `id` with the value of `qa-name`
+
+### S3 Example
+
+```hcl
+module "s3-name" {
+  source        = "devops-workflow/label/local"
+  version       = "0.1.2"
+  name          = "data"
+  environment   = "qa"
+  organization  = "corp"
+  namespace-org = "true"
+}
+```
+This will create an `id` with the value of `corp-qa-data`
+
+Now reference `label` outputs to create the S3 bucket
+
+```hcl
+resource "aws_s3_bucket" "data" {
+  bucket  = "${module.s3-name.id}"
+  tags    = "${module.s3-name.tags}"
+```
+
+### All Variables Example
+Using in a module and exposing all settings to upstream caller.
+
+```hcl
+module "label" {
+  source        = "devops-workflow/label/local"
+  version       = "0.1.2"
+  organization  = "${var.organization}"
+  name          = "${var.name}"
+  namespace-env = "${var.namespace-env}"
+  namespace-org = "${var.namespace-org}"
+  environment   = "${var.environment}"
+  delimiter     = "${var.delimiter}"
+  attributes    = "${var.attributes}"
+  tags          = "${var.tags}"
+}
+```

outputs.tf

@@ -49,8 +49,10 @@ output "tags" {
 }
 //debugging
 output "org_attr_20" {
-  value = "${local.org_attr_20}"
+  description = "Internal debugging. DO NOT USE"
+  value       = "${local.org_attr_20}"
 }
 output "org_attr_32" {
-  value = "${local.org_attr_32}"
+  description = "Internal debugging. DO NOT USE"
+  value       = "${local.org_attr_32}"
 }

variables.tf

@@ -4,33 +4,33 @@ variable "attributes" {
   default     = []
 }
 variable "autoscaling_group" {
-  description = "If true, generate ASG tags map resource"
+  description = "DOES NOTHING YET. If true, generate ASG tags map resource"
   default     = false
 }
 variable "delimiter" {
   description = "Delimiter to be used between `name`, `namespaces`, `attributes`, etc."
   default     = "-"
 }
 variable "environment" {
-  description = "Environment (ex: dev, qa, stage, prod)"
+  description = "Environment (ex: `dev`, `qa`, `stage`, `prod`). (Second or top level namespace. Depending on namespacing options)"
 }
 variable "name" {
   description = "Base name for resource"
 }
 variable "namespace-env" {
-  description = "Prefix name with the environment"
+  description = "Prefix name with the environment. If true, format is: <env>-<name>"
   default     = true
 }
 variable "namespace-org" {
-  description = "Prefix name with the organization. If both env and org namespaces are used, format will be <org>-<env>-<name>"
+  description = "Prefix name with the organization. If true, format is: <org>-<env namespaced name>. If both env and org namespaces are used, format will be <org>-<env>-<name>"
   default     = false
 }
 variable "organization" {
-  description = "Organization name"
+  description = "Organization name (Top level namespace)."
   default     = ""
 }
 variable "tags" {
-  description = "A map of tags to add to all resources"
+  description = "A map of additional tags"
   type        = "map"
   default     = {}
 }