From 9184ac90e55d5cda5feb26ea84cfe44136019686 Mon Sep 17 00:00:00 2001
From: Tewson Seeoun <tewson.seeoun@gmail.com>
Date: Wed, 17 Apr 2024 01:03:32 +0100
Subject: [PATCH] Update README

---
 README.md | 23 +++++++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 3162ace..ba198bf 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,27 @@
-# Voter Guide 2024
+# 2024 Local Elections Voter Guide
 
 Voter Guide for 2024 Irish Local Elections in Dublin City Council and Fingal County Council
 
-## 🧞 Commands
+## Getting started
+
+This project uses the [Astro web framework](https://astro.build/). Node.js v20.3.0 or higher is recommended.
+
+The code requires an [Airtable](https://airtable.com) base as a data source. Contact us to get a template of the data structure.
+
+```
+git clone https://github.com/DublinInquirer/voter-guide-2024
+cd voter-guide-2024
+npm install
+```
+
+### Environment variables
+
+Create a `.env` file with the environment variables below.
+
+- **AIRTABLE_API_KEY** - An API key for retrieving data from Airtable.
+- **GOOGLE_TAG_ID** - (Optional) A Google tag ID for Google Analytics.
+
+## Commands
 
 All commands are run from the root of the project, from a terminal: