From 438ae651c2c4c625e5f0133008269c6de1c0b036 Mon Sep 17 00:00:00 2001
From: Lillian Skinner <lillian@randommeaninglesscharacters.com>
Date: Thu, 2 Apr 2026 12:56:16 -0400
Subject: [PATCH] Update README.md

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/README.md b/README.md
index 451938f..61f7eb3 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,22 @@
 # Scrape_eScribe
 
+This bash script will scrape meetings from the eScribe meetings platform. `websites.csv` holds an index of domains to crawl. The format is as follows:
+```
+"<eScribe domain>","<output directory>","<leave empty, this entry is used by other tools>"
+```
+As an example, an entry might look like this:
+```
+"https://pub-london.escribemeetings.com/", "LondonArchive", ""
+```
+Files will be output to `./LondonArchive/Meetings/`.
+
+The basic structure of the output files is:
+```
+./LondonArchive/Meetings/<board/committee name>/<year>/<mm-dd>/
+                                                              |- <agenda>.pdf
+                                                              |- <minutes>.pdf
+                                                              \- Attachments/
+                                                                            |- <attachment 1>.pdf
+                                                                            |- <attachment 2>.pdf
+                                                                            \- etc etc
+```
\ No newline at end of file