Added README to all modules (#45)

modules/README.md

@@ -29,3 +29,5 @@ List of Security Groups implemented as Terraform modules
 * [web](web)
 * [zipkin](zipkin)
 * [zookeeper](zookeeper)
+* [_templates](_templates) - Source templates for all other modules. Change carefully, test thoughtfully!
+

modules/carbon-relay-ng/README.md

+# carbon-relay-ng - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "carbon_relay-ng_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/carbon-relay-ng"
+
+  # omitted...
+}
+```
+
+All automatic values **carbon-relay-ng module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/carbon-relay-ng/auto_values.tf).

modules/cassandra/README.md

+# cassandra - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "cassandra_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/cassandra"
+
+  # omitted...
+}
+```
+
+All automatic values **cassandra module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/cassandra/auto_values.tf).

modules/consul/README.md

+# consul - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "consul_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/consul"
+
+  # omitted...
+}
+```
+
+All automatic values **consul module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/consul/auto_values.tf).

modules/docker-swarm/README.md

+# docker-swarm - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "docker_swarm_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/docker-swarm"
+
+  # omitted...
+}
+```
+
+All automatic values **docker-swarm module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/docker-swarm/auto_values.tf).

modules/elasticsearch/README.md

+# elasticsearch - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "elasticsearch_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/elasticsearch"
+
+  # omitted...
+}
+```
+
+All automatic values **elasticsearch module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/elasticsearch/auto_values.tf).

modules/http-80/README.md

+# http-80 - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "http_80_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/http-80"
+
+  # omitted...
+}
+```
+
+All automatic values **http-80 module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/http-80/auto_values.tf).

modules/https-443/README.md

+# https-443 - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "https_443_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/https-443"
+
+  # omitted...
+}
+```
+
+All automatic values **https-443 module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/https-443/auto_values.tf).

modules/ipsec-4500/README.md

+# ipsec-4500 - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "ipsec_4500_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/ipsec-4500"
+
+  # omitted...
+}
+```
+
+All automatic values **ipsec-4500 module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/ipsec-4500/auto_values.tf).

modules/ipsec-500/README.md

+# ipsec-500 - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "ipsec_500_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/ipsec-500"
+
+  # omitted...
+}
+```
+
+All automatic values **ipsec-500 module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/ipsec-500/auto_values.tf).

modules/kafka/README.md

+# kafka - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "kafka_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/kafka"
+
+  # omitted...
+}
+```
+
+All automatic values **kafka module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/kafka/auto_values.tf).

modules/ldaps/README.md

+# ldaps - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "ldaps_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/ldaps"
+
+  # omitted...
+}
+```
+
+All automatic values **ldaps module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/ldaps/auto_values.tf).

modules/memcached/README.md

+# memcached - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "memcached_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/memcached"
+
+  # omitted...
+}
+```
+
+All automatic values **memcached module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/memcached/auto_values.tf).

modules/mssql/README.md

+# mssql - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "mssql_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/mssql"
+
+  # omitted...
+}
+```
+
+All automatic values **mssql module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/mssql/auto_values.tf).

modules/mysql/README.md

+# mysql - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "mysql_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/mysql"
+
+  # omitted...
+}
+```
+
+All automatic values **mysql module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/mysql/auto_values.tf).

modules/nfs/README.md

+# nfs - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "nfs_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/nfs"
+
+  # omitted...
+}
+```
+
+All automatic values **nfs module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/nfs/auto_values.tf).

modules/nomad/README.md

+# nomad - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "nomad_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/nomad"
+
+  # omitted...
+}
+```
+
+All automatic values **nomad module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/nomad/auto_values.tf).

modules/openvpn/README.md

+# openvpn - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "openvpn_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/openvpn"
+
+  # omitted...
+}
+```
+
+All automatic values **openvpn module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/openvpn/auto_values.tf).

modules/postgresql/README.md

+# postgresql - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "postgresql_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/postgresql"
+
+  # omitted...
+}
+```
+
+All automatic values **postgresql module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/postgresql/auto_values.tf).

modules/rdp/README.md

+# rdp - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "rdp_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/rdp"
+
+  # omitted...
+}
+```
+
+All automatic values **rdp module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/rdp/auto_values.tf).

modules/redis/README.md

+# redis - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "redis_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/redis"
+
+  # omitted...
+}
+```
+
+All automatic values **redis module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/redis/auto_values.tf).

modules/redshift/README.md

+# redshift - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "redshift_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/redshift"
+
+  # omitted...
+}
+```
+
+All automatic values **redshift module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/redshift/auto_values.tf).

modules/splunk/README.md

+# splunk - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "splunk_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/splunk"
+
+  # omitted...
+}
+```
+
+All automatic values **splunk module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/splunk/auto_values.tf).

modules/ssh/README.md

+# ssh - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "ssh_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/ssh"
+
+  # omitted...
+}
+```
+
+All automatic values **ssh module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/ssh/auto_values.tf).

modules/storm/README.md

+# storm - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "storm_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/storm"
+
+  # omitted...
+}
+```
+
+All automatic values **storm module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/storm/auto_values.tf).

modules/web/README.md

+# web - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "web_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/web"
+
+  # omitted...
+}
+```
+
+All automatic values **web module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/web/auto_values.tf).

modules/zipkin/README.md

+# zipkin - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "zipkin_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/zipkin"
+
+  # omitted...
+}
+```
+
+All automatic values **zipkin module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/zipkin/auto_values.tf).

modules/zookeeper/README.md

+# zookeeper - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+```hcl
+module "zookeeper_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/zookeeper"
+
+  # omitted...
+}
+```
+
+All automatic values **zookeeper module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/zookeeper/auto_values.tf).

update_groups.sh

@@ -120,6 +120,22 @@ variable "auto_egress_with_self" {
   type        = "list"
   default     = $egress_with_self
 }
+EOF
+
+    cat <<EOF > "modules/$group/README.md"
+# $group - AWS EC2-VPC Security Group Terraform module
+
+## Usage
+
+\`\`\`hcl
+module "${group/-/_}_security_group" {
+  source = "terraform-aws-modules/security-group/aws//modules/${group}"
+
+  # omitted...
+}
+\`\`\`
+
+All automatic values **${group} module** is using are available [here](https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/master/modules/${group}/auto_values.tf).
 EOF
 
     list_of_modules=$(echo "$list_of_modules"; echo "* [$group]($group)")
@@ -135,6 +151,8 @@ List of Security Groups implemented as Terraform modules
 ========================================================
 
 $list_of_modules
+* [_templates](_templates) - Source templates for all other modules. Change carefully, test thoughtfully!
+
 EOF
 
   echo "Done!"