update readme.md

README.md

@@ -2,3 +2,18 @@
 
 Migrate the coventry university student timetable to an ics file
 
+# Instructions
+
+1. run `pip install -r requirements.txt`
+
+2. if `calender.ics` exists already, rename it to `old_calender.ics`. This will allow the new calender file to update events from the old calender, and remove deleted events.
+
+3. log into the coventry university timetable website, go into inspect element, go to the network tab and copy the response from the first request (refresh if no requests are showing up)
+
+![copy response](images/step1.png)
+
+4. paste the response data into a file in the root of the repo called `response.txt`
+
+![paste response.txt](images/step2.png)
+
+5. run `main.py`, and you'll hopefully see `calender.ics` get created in the root folder of the repo :)

requirements.txt

@@ -0,0 +1,5 @@
+beautifulsoup4==4.14.3
+bs4==0.0.2
+pytz==2025.2
+soupsieve==2.8.2
+typing_extensions==4.15.0