diff --git a/README.md b/README.md index 15a742d22a32a0a7a07a81f03868ae0a4155be08..ac009b61dc1d32b9cb93d5d6f8f276eb82eecb3b 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