Update README.md

README.md

@@ -1,5 +1,32 @@
 # AquaCulture Data Platform
 
+## Setup Guide
+
+### 1. Setup a resource group for the terraform state 
+
+In order to properly manage the terraform .state file, one creates a resource group in azure with a storage account to hold the terraform state. 
+This is then referenced in the `terraform/backend.tf` clause in the terraform configuration. If you have created a new resource group and storage account, you must change the names in the `†erraform/backend.tf` to match the names of the resources you created. 
+
+### 2. Run terraform configuration in order to populate the cloud with the required resources. 
+
+1. az login
+2. terraform init
+3. terraform plan
+4. terraform apply
+
+### 3. Add Azure Container Registry secrets into Github actions 
+
+In order for the api docker image to be published to the Azure Container Registry (ACR) we need to add three variables to the github repo. These variables are listed below, and can be found in the azure portal after navigating
+
+1. ACR_PASSWORD
+2. ACR_USERNAME 
+3. ARC_SERVER (the whole path to the arc, including the .azurecr.io suffix
+
+### 4. Run the Github Actions to publish 
+
+Navigate to the `Actions` tab in Github, and check if the actions script for publishing an image to Azure Container Registry have run successfully. If not, then restart it in order to publish the code to the registry 
+
+
 ## Overview
 
 This project is a template for a data platform designed for small and medium-large aquaculture companies in Norway. It leverages the power of Azure, Databricks, and Terraform to provide a scalable and efficient solution for managing and transforming data. The platform follows the **Medallion Architecture** and fetches data daily from [api.havvarsel.no](https://api.havvarsel.no).