Update readme (#15)

* Update readme

* Fix mnt

.README.md

@@ -0,0 +1,146 @@
+## {{ (datasource "git").name }} [![Build Status](https://travis-ci.org/cloudposse/terraform-null-label.svg)](https://travis-ci.org/cloudposse/terraform-null-label)
+{{ (datasource "section").warning }}
+
+Terraform module designed to generate consistent label names and tags for resources. Use `terraform-null-label` to implement a strict naming convention.
+
+A label follows the following convention: `{namespace}-{stage}-{name}-{attributes}`. The delimiter (e.g. `-`) is interchangeable.
+
+It's recommended to use one `terraform-null-label` module for every unique resource of a given resource type.
+For example, if you have 10 instances, there should be 10 different labels.
+However, if you have multiple different kinds of resources (e.g. instances, security groups, file systems, and elastic ips), then they can all share the same label assuming they are logically related.
+
+All [Cloud Posse modules](https://github.com/cloudposse?utf8=%E2%9C%93&q=tf_&type=&language=) use this module to ensure resources can be instantiated multiple times within an account and without conflict.
+
+-**NOTE:** The `null` refers to the primary Terraform [provider](https://www.terraform.io/docs/providers/null/index.html) used in this module.
+
+## Usage
+
+### Simple Example
+
+Include this repository as a module in your existing terraform code:
+
+```hcl
+module "eg_prod_bastion_label" {
+  source     = "git::https://github.com/cloudposse/terraform-null-label.git?ref=master"
+  namespace  = "eg"
+  stage      = "prod"
+  name       = "bastion"
+  attributes = ["public"]
+  delimiter  = "-"
+  tags       = "${map("BusinessUnit", "XYZ", "Snapshot", "true")}"
+}
+```
+
+This will create an `id` with the value of `eg-prod-bastion-public`.
+
+Now reference the label when creating an instance (for example):
+
+```hcl
+resource "aws_instance" "eg_prod_bastion_public" {
+  instance_type = "t1.micro"
+  tags          = "${module.eg_prod_bastion_label.tags}"
+}
+```
+
+Or define a security group:
+
+```hcl
+resource "aws_security_group" "eg_prod_bastion_public" {
+  vpc_id = "${var.vpc_id}"
+  name   = "${module.eg_prod_bastion_label.id}"
+  tags   = "${module.eg_prod_bastion_label.tags}"
+  egress {
+    from_port   = 0
+    to_port     = 0
+    protocol    = "-1"
+    cidr_blocks = ["0.0.0.0/0"]
+  }
+}
+```
+
+
+### Advanced Example
+
+Here is a more complex example with two instances using two different labels. Note how efficiently the tags are defined for both the instance and the security group.
+
+```hcl
+module "eg_prod_bastion_abc_label" {
+  source     = "git::https://github.com/cloudposse/terraform-null-label.git?ref=master"
+  namespace  = "eg"
+  stage      = "prod"
+  name       = "bastion"
+  attributes = ["abc"]
+  delimiter  = "-"
+  tags       = "${map("BusinessUnit", "ABC")}"
+}
+
+resource "aws_security_group" "eg_prod_bastion_abc" {
+  name = "${module.eg_prod_bastion_abc_label.id}"
+  tags = "${module.eg_prod_bastion_abc_label.tags}"
+  ingress {
+    from_port   = 22
+    to_port     = 22
+    protocol    = "tcp"
+    cidr_blocks = ["0.0.0.0/0"]
+  }
+}
+
+resource "aws_instance" "eg_prod_bastion_abc" {
+   instance_type          = "t1.micro"
+   tags                   = "${module.eg_prod_bastion_abc_label.tags}"
+   vpc_security_group_ids = ["${aws_security_group.eg_prod_bastion_abc.id"}]
+}
+
+module "eg_prod_bastion_xyz_label" {
+  source     = "git::https://github.com/cloudposse/terraform-null-label.git?ref=master"
+  namespace  = "eg"
+  stage      = "prod"
+  name       = "bastion"
+  attributes = ["xyz"]
+  delimiter  = "-"
+  tags       = "${map("BusinessUnit", "XYZ")}"
+}
+
+resource "aws_security_group" "eg_prod_bastion_xyz" {
+  name = "module.eg_prod_bastion_xyz_label.id"
+  tags = "${module.eg_prod_bastion_xyz_label.tags}"
+  ingress {
+    from_port   = 22
+    to_port     = 22
+    protocol    = "tcp"
+    cidr_blocks = ["0.0.0.0/0"]
+  }
+}
+
+resource "aws_instance" "eg_prod_bastion_xyz" {
+   instance_type          = "t1.micro"
+   tags                   = "${module.eg_prod_bastion_xyz_label.tags}"
+   vpc_security_group_ids = ["${aws_security_group.eg_prod_bastion_xyz.id}"]
+}
+```
+
+{{ (datasource "terraform").input }}
+
+**WARNING** Any tags passed as an input to this module will *override* the tags generated by this module.
+
+{{ (datasource "terraform").output }}
+
+{{ (datasource "section").help }}
+
+{{ (datasource "section").contributing }}
+
+{{ (datasource "license").apache2 }}
+
+{{ (datasource "section").about }}
+
+### Contributors
+
+|
+{{- (datasource "contributor").erik }} |
+{{- (datasource "contributor").igor }} |
+{{- (datasource "contributor").konstantin }} |
+{{- (datasource "contributor").andrew }} |
+{{- (datasource "contributor").sergey }} |
+|---|---|---|---|---|
+
+{{ (datasource "contributor")._links }}

README.md

@@ -1,12 +1,16 @@
-# terraform-null-label [![Build Status](https://travis-ci.org/cloudposse/terraform-null-label.svg)](https://travis-ci.org/cloudposse/terraform-null-label)
+## terraform-null-label [![Build Status](https://travis-ci.org/cloudposse/terraform-null-label.svg)](https://travis-ci.org/cloudposse/terraform-null-label)
+<!---
+  --- This file was automatically generated by the `build-harness`
+  --- Make changes instead to `.README.md` and rebuild.
+  --->
 
-Terraform module designed to generate consistent label names and tags for resources. Use `terraform-null-label` to implement a strict naming convention. 
+Terraform module designed to generate consistent label names and tags for resources. Use `terraform-null-label` to implement a strict naming convention.
 
-A label follows the following convention: `{namespace}-{stage}-{name}-{attributes}`. The delimiter (e.g. `-`) is interchangeable. 
+A label follows the following convention: `{namespace}-{stage}-{name}-{attributes}`. The delimiter (e.g. `-`) is interchangeable.
 
-It's recommended to use one `terraform-null-label` module for every unique resource of a given resource type. 
-For example, if you have 10 instances, there should be 10 different labels. 
-However, if you have multiple different kinds of resources (e.g. instances, security groups, file systems, and elastic ips), then they can all share the same label assuming they are logically related. 
+It's recommended to use one `terraform-null-label` module for every unique resource of a given resource type.
+For example, if you have 10 instances, there should be 10 different labels.
+However, if you have multiple different kinds of resources (e.g. instances, security groups, file systems, and elastic ips), then they can all share the same label assuming they are logically related.
 
 All [Cloud Posse modules](https://github.com/cloudposse?utf8=%E2%9C%93&q=tf_&type=&language=) use this module to ensure resources can be instantiated multiple times within an account and without conflict.
 
@@ -30,7 +34,7 @@ module "eg_prod_bastion_label" {
 }
 ```
 
-This will create an `id` with the value of `eg-prod-bastion-public`. 
+This will create an `id` with the value of `eg-prod-bastion-public`.
 
 Now reference the label when creating an instance (for example):
 
@@ -88,7 +92,7 @@ resource "aws_instance" "eg_prod_bastion_abc" {
    instance_type          = "t1.micro"
    tags                   = "${module.eg_prod_bastion_abc_label.tags}"
    vpc_security_group_ids = ["${aws_security_group.eg_prod_bastion_abc.id"}]
-} 
+}
 
 module "eg_prod_bastion_xyz_label" {
   source     = "git::https://github.com/cloudposse/terraform-null-label.git?ref=master"
@@ -118,27 +122,117 @@ resource "aws_instance" "eg_prod_bastion_xyz" {
 }
 ```
 
+## Input
 
-## Variables
-
-|  Name                        |  Default       |  Description                                                | Required |
-|:-----------------------------|:--------------:|:------------------------------------------------------------|:--------:|
-| namespace                    | ``             | Namespace (e.g. `cp` or `cloudposse`)                       | Yes      |
-| stage                        | ``             | Stage (e.g. `prod`, `dev`, `staging`)                       | Yes      |
-| name                         | ``             | Name  (e.g. `bastion` or `db`)                              | Yes      | 
-| attributes                   | []             | Additional attributes (e.g. `policy` or `role`)             | No       | 
-| tags                         | {}             | Additional tags  (e.g. `map("BusinessUnit","XYZ")`          | No       |
-| enabled                      | true           | Set to false to prevent the module from creating anything   | No       | 
+<!--------------------------------REQUIRE POSTPROCESSING-------------------------------->
+|  Name |  Default  |  Description  |
+|:------|:---------:|:--------------:|
+| attributes |[] |Additional attributes (e.g. `policy` or `role`)|
+| delimiter |"-" |Delimiter to be used between `name`, `namespace`, `stage`, etc.|
+| enabled |"true" |Set to false to prevent the module from creating any resources|
+| name |__REQUIRED__ |Solution name, e.g. 'app' or 'jenkins'|
+| namespace |__REQUIRED__ |Namespace, which could be your organization name, e.g. 'cp' or 'cloudposse'|
+| stage |__REQUIRED__ |Stage, e.g. 'prod', 'staging', 'dev', or 'test'|
+| tags |{} |Additional tags (e.g. `map('BusinessUnit`,`XYZ`)|
 
 **WARNING** Any tags passed as an input to this module will *override* the tags generated by this module.
 
-## Outputs
+## Output
+
+<!--------------------------------REQUIRE POSTPROCESSING-------------------------------->
+|  Name | Description  |
+|:------|:------------:|
+| attributes | Normalized attributes  |
+| id | Disambiguated ID  |
+| name | Normalized name  |
+| namespace | Normalized namespace  |
+| stage | Normalized stage  |
+| tags | Merge input tags with our tags. Note: `Name` has a special meaning in AWS and we need to disamgiuate it by using the computed `id`   |
+
+## Help
+
+**Got a question?**
+
+File a GitHub [issue](https://github.com/cloudposse/terraform-null-label/issues), send us an [email](mailto:[email protected]) or reach out to us on [Gitter](https://gitter.im/cloudposse/).
+
+## Contributing
+
+### Bug Reports & Feature Requests
+
+Please use the [issue tracker](https://github.com/cloudposse/terraform-null-label/issues) to report any bugs or file feature requests.
+
+### Developing
+
+If you are interested in being a contributor and want to get involved in developing `terraform-null-label`, we would love to hear from you! Shoot us an [email](mailto:[email protected]).
+
+In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
+
+ 1. **Fork** the repo on GitHub
+ 2. **Clone** the project to your own machine
+ 3. **Commit** changes to your own branch
+ 4. **Push** your work back up to your fork
+ 5. Submit a **Pull request** so that we can review your changes
+
+**NOTE:** Be sure to merge the latest from "upstream" before making a pull request!
+
+## License
+
+[APACHE 2.0](LICENSE) © 2017 [Cloud Posse, LLC](https://cloudposse.com)
+
+See [LICENSE](LICENSE) for full details.
+
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+## About
+
+This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know at <[email protected]>
+
+We love [Open Source Software](https://github.com/cloudposse/)!
+
+See [our other projects][community]
+or [hire us][hire] to help build your next cloud-platform.
+
+  [website]: http://cloudposse.com/
+  [community]: https://github.com/cloudposse/
+  [hire]: http://cloudposse.com/contact/
+
+### Contributors
+
+|[![Erik Osterman][erik_img]][erik_web]<br/>[Erik Osterman][erik_web] |[![Igor Rodionov][igor_img]][igor_web]<br/>[Igor Rodionov][igor_img] |[![Konstantin B][konstantin_img]][konstantin_web]<br/>[Konstantin B][konstantin_web] |[![Andriy Knysh][andriy_img]][andriy_web]<br/>[Andriy Knysh][andriy_web] |[![Sergey Vasilyev][sergey_img]][sergey_web]<br/>[Sergey Vasilyev][sergey_web] |
+|---|---|---|---|---|
+
+[andriy_img]: https://avatars0.githubusercontent.com/u/7356997?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144
+[andriy_web]: https://github.com/aknysh/
+
+[erik_img]: http://s.gravatar.com/avatar/88c480d4f73b813904e00a5695a454cb?s=144
+[erik_web]: https://github.com/osterman/
+
+[igor_img]: http://s.gravatar.com/avatar/bc70834d32ed4517568a1feb0b9be7e2?s=144
+[igor_web]: https://github.com/goruha/
+
+[konstantin_img]: https://avatars1.githubusercontent.com/u/11299538?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144
+[konstantin_web]: https://github.com/comeanother/
+
+[sergey_img]: https://avatars1.githubusercontent.com/u/1134449?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144
+[sergey_web]: https://github.com/s2504s/
+
+[valeriy_img]: https://avatars1.githubusercontent.com/u/10601658?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144
+[valeriy_web]: https://github.com/drama17/
 
-| Name              | Description            |
-|:------------------|:----------------------|
-| id                | Disambiguated ID      |
-| name              | Normalized name       |
-| namespace         | Normalized namespace  |
-| stage             | Normalized stage      |
-| attributes        | Normalized attributes |
-| tags              | Normalized Tag map    |
+[vladimir_img]: https://avatars1.githubusercontent.com/u/26582191?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144
+[vladimir_web]: https://github.com/SweetOps/

outputs.tf

@@ -1,33 +1,40 @@
 output "id" {
-  value = "${null_resource.default.triggers.id}"
+  value       = "${null_resource.default.triggers.id}"
+  description = "Disambiguated ID"
 }
 
 output "name" {
-  value = "${null_resource.default.triggers.name}"
+  value       = "${null_resource.default.triggers.name}"
+  description = "Normalized name"
 }
 
 output "namespace" {
-  value = "${null_resource.default.triggers.namespace}"
+  value       = "${null_resource.default.triggers.namespace}"
+  description = "Normalized namespace"
 }
 
 output "stage" {
-  value = "${null_resource.default.triggers.stage}"
+  value       = "${null_resource.default.triggers.stage}"
+  description = "Normalized stage"
 }
 
 output "attributes" {
-  value = "${null_resource.default.triggers.attributes}"
+  value       = "${null_resource.default.triggers.attributes}"
+  description = "Normalized attributes"
 }
 
 # Merge input tags with our tags.
 # Note: `Name` has a special meaning in AWS and we need to disamgiuate it by using the computed `id`
 output "tags" {
   value = "${
-    merge( 
-      map(
-        "Name", "${null_resource.default.triggers.id}",
-        "Namespace", "${null_resource.default.triggers.namespace}",
-        "Stage", "${null_resource.default.triggers.stage}"
-      ), var.tags
-    )
-  }"
+      merge( 
+        map(
+          "Name", "${null_resource.default.triggers.id}",
+          "Namespace", "${null_resource.default.triggers.namespace}",
+          "Stage", "${null_resource.default.triggers.stage}"
+        ), var.tags
+      )
+    }"
+
+  description = "Normalized Tag map"
 }

variables.tf

@@ -1,6 +1,14 @@
-variable "namespace" {}
-variable "stage" {}
-variable "name" {}
+variable "namespace" {
+  description = "Namespace, which could be your organization name, e.g. 'cp' or 'cloudposse'"
+}
+
+variable "stage" {
+  description = "Stage, e.g. 'prod', 'staging', 'dev', or 'test'"
+}
+
+variable "name" {
+  description = "Solution name, e.g. 'app' or 'jenkins'"
+}
 
 variable "enabled" {
   description = "Set to false to prevent the module from creating any resources"