From ea0329bef37becd267e620cca7b39cd8bca30de4 Mon Sep 17 00:00:00 2001
From: Franco Reyes <79299724+francojreyes@users.noreply.github.com>
Date: Sat, 30 Mar 2024 00:34:27 +1100
Subject: [PATCH] Add docs on updating

---
 README.md | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 05eb17c..3e51288 100644
--- a/README.md
+++ b/README.md
@@ -49,4 +49,19 @@ The following relationships exist between tables. These relationships are tracke
 - Every **building** contains 1 or more **rooms**
 - Every **room** belongs to a **building**
 - Every **room** has 0 or more **bookings**
-- Every **booking** is for a specific **room**
\ No newline at end of file
+- Every **booking** is for a specific **room**
+
+## Making Changes
+### Schema updates
+To update the schema, you will need to:
+- Update the relevant `up.sql` and `down.sql` files in the root `sql/` directory
+- Update the scrapers to produce this data
+
+### Adding additional scrapers
+To add additional scrapers, you will need to:
+- Create a new subdirectory with the scraper inside it
+- Ensure that if you are using the schema SQL files, you reference them using symlinks so all scrapers are updated
+- Add to the GitHub workflow so that it also tests/builds/deploys the new scraper
+
+### Testing
+See the [DevSoc GraphQL API docs](https://github.com/devsoc-unsw/graphql-api/blob/master/scrapers.md) on how to test scrapers.