diff --git a/README.md b/README.md index b0cba0d..c5e7fef 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Web interface to retrieve and convert a coventry university student timetable to an '.ics. file. -# Instructions +# Setup 1. run `pip install -r requirements.txt` @@ -10,8 +10,11 @@ Web interface to retrieve and convert a coventry university student timetable to 3. run main.py -4. go to the web interface (at http://localhost:3000 by default) +# Usage -5. input your coventry university username and password (the one you would normally use to access the timetable website) +1. go to the web interface (at http://localhost:3000 by default) + ![Login Screen](images/login_example.png) -6. either subscribe to the link in your calendar app (you will need to leave the server running for the updating to work) or download the .ics file and import it into your calendar app (e.g. Thunderbird, Apple Calendar) \ No newline at end of file +2. input your coventry university username and password (the one you would normally use to access the timetable website) + +3. either subscribe to the link in your calendar app (you will need to leave the server running for the updating to work) or download the .ics file and import it into your calendar app (e.g. Thunderbird, Apple Calendar) \ No newline at end of file diff --git a/images/login_example.png b/images/login_example.png new file mode 100644 index 0000000..e3e94ed Binary files /dev/null and b/images/login_example.png differ