From 4c527ebe647dba99e725f4305372072983bd061a Mon Sep 17 00:00:00 2001
From: Don Badrak <donald.e.badrak.ii@census.gov>
Date: Fri, 28 Jun 2019 14:16:45 -0400
Subject: [PATCH] update usage

---
 ois-scanner/README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 ois-scanner/main.tf   | 13 +++++++++++--
 2 files changed, 52 insertions(+), 2 deletions(-)

diff --git a/ois-scanner/README.md b/ois-scanner/README.md
index e69de29..a8d8b4c 100644
--- a/ois-scanner/README.md
+++ b/ois-scanner/README.md
@@ -0,0 +1,41 @@
+# About
+
+This describes how to use the aws-common-securit-grous submodule for ois-scanner. This sets up
+a module for a security group in the respective VPC.  When construting a new VPC, we want to include
+this module.  This should be in each VPC we have, in production.  We probably need a similar one
+for the CAT environment, but we'll tackle that when we get to it.
+
+# Usage
+
+```code
+module "ois-scanner" {
+  source = "git::https://vc1.csvd.census.gov/terraform-modules/aws-common-security-groups.git/ois-scanner"
+
+  vpc_id = "${var.vpc_id}"
+  tags = { }
+  # Name, CostAllocation, and Environment are pre-set
+}
+```
+
+## Required Inputs
+
+The following input variables are required:
+
+### vpc\_id
+
+Description: VPC ID Number
+
+Type: `string`
+
+## Optional Inputs
+
+The following input variables are optional (have default values):
+
+### tags
+
+Description: Extra security group tags
+
+Type: `map`
+
+Default: `<map>`
+
diff --git a/ois-scanner/main.tf b/ois-scanner/main.tf
index 8892449..846a18d 100644
--- a/ois-scanner/main.tf
+++ b/ois-scanner/main.tf
@@ -1,13 +1,22 @@
 /**
- * Usage:
+* # About
 * 
+* This describes how to use the aws-common-securit-grous submodule for ois-scanner. This sets up
+* a module for a security group in the respective VPC.  When construting a new VPC, we want to include
+* this module.  This should be in each VPC we have, in production.  We probably need a similar one
+* for the CAT environment, but we'll tackle that when we get to it.
+* 
+* # Usage
+* 
+* ```code
 * module "ois-scanner" {
-*   source = "aws-common-security-groups/ois-scanner"
+*   source = "git::https://vc1.csvd.census.gov/terraform-modules/aws-common-security-groups.git/ois-scanner"
 * 
 *   vpc_id = "${var.vpc_id}"
 *   tags = { }
 *   # Name, CostAllocation, and Environment are pre-set
 * }
+* ```
 */
 
 locals {