From ffd3ba0e5801d3e168fd6d11d8569b8f07fda77b Mon Sep 17 00:00:00 2001
From: Tamas Kiss <kiss.tamas94@gmail.com>
Date: Fri, 27 May 2022 04:03:30 +0200
Subject: [PATCH] docs: updated readme and added terraform-docs config

---
 .terraform-docs.yml | 5 +++++
 README.md           | 9 +++++++++
 2 files changed, 14 insertions(+)
 create mode 100644 .terraform-docs.yml

diff --git a/.terraform-docs.yml b/.terraform-docs.yml
new file mode 100644
index 0000000..e41c6c7
--- /dev/null
+++ b/.terraform-docs.yml
@@ -0,0 +1,5 @@
+formatter: markdown document
+
+output:
+  mode: inject
+  file: README.md
diff --git a/README.md b/README.md
index 01d397d..f8710ea 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,11 @@
+# Terraform module for Lawndale Kubernetes environment
+[![Build Status](https://drone.thomasklein.me/api/badges/thomasklein/terraform-lawndale-k8s/status.svg)](https://drone.thomasklein.me/thomasklein/terraform-lawndale-k8s)
+
+This module manages the core Kubernetes cluster components running on Lawndale including workers. 
+
+
+
+<!-- BEGIN_TF_DOCS -->
 ## Requirements
 
 The following requirements are needed by this module:
@@ -128,3 +136,4 @@ Default: `"udp"`
 ## Outputs
 
 No outputs.
+<!-- END_TF_DOCS -->