From 22ae9f21f02b57c87a79feb54ee67270343c3d2c Mon Sep 17 00:00:00 2001
From: Adar Nimrod <nimrod@shore.co.il>
Date: Thu, 7 Oct 2021 20:55:45 +0300
Subject: [PATCH] Some general documentation.

---
 README.md | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 15a742d..ac009b6 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,15 @@
-# PROJECT_NAME
+# Example IaC project
+
+An example infrastructure-as-code project to show a simple project structure.
+
+## A note on structure
+
+This repo is first divided by the main tool used instead of by the service or
+part of the infrastructure. One reason is to document the workflow with that
+specific tool in just 1 place, not copied across different READMEs for each
+service. Another reason is that we can more easily setup our CI/CD pipeline
+trigges. For example, build a container image if files under
+`Containerfiles/<service>` have changed.
 
 ## License
 
-- 
GitLab