tweaks

README.md

@@ -1 +1,25 @@
 # terraform-hashicorp-s1
+A simple module to return HashiCorp's S-1 filing status
+
+## Requirements
+
+No requirements.
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| sec | n/a |
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| company\_name | name of company to lookup s-1 status | `string` | `"hashicorp"` | no |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| s1\_status | status message regarding s-1 filing |
+

locals.tf

@@ -0,0 +1,3 @@
+locals {
+  message = data.sec_s1_filing.company.status ? "has filed their s-1" : "has not filed their s-1"
+}

main.tf

@@ -6,20 +6,3 @@ terraform {
   }
 }
 
-variable "company_name" {
-  type        = string
-  description = "name of company to lookup s-1 status"
-  default     = "hashicorp"
-}
-
-locals {
-  message = data.sec_s1_filing.company.status ? "has filed their s-1" : "has not filed their s-1"
-}
-
-data "sec_s1_filing" "company" {
-  name = var.company_name
-}
-
-output "s1_status" {
-  value = "${data.sec_s1_filing.company.name} ${local.message}"
-}

outputs.tf

@@ -0,0 +1,4 @@
+output "s1_status" {
+  description = "status message regarding s-1 filing"
+  value = "${data.sec_s1_filing.company.name} ${local.message}"
+}

s1_filing.tf

@@ -0,0 +1,3 @@
+data "sec_s1_filing" "company" {
+  name = var.company_name
+}

variables.tf

@@ -0,0 +1,5 @@
+variable "company_name" {
+  type        = string
+  description = "name of company to lookup s-1 status"
+  default     = "hashicorp"
+}