From d8797fe8ead7c557afb486b905c7cb848c63f39a Mon Sep 17 00:00:00 2001
From: Sven Geboers <geboers.sven@gmail.com>
Date: Thu, 2 Feb 2023 16:30:13 +0100
Subject: [PATCH] README.md

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6d260f6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# GTFS-RT: following transit vehicles in real time
+This repository contains a script that can be used to host a bokeh server.
+This bokeh server will show the live locations of busses, trams, metros, and ferrys in the Netherlands (updated every 30 seconds).
+
+# Prerequisites
+One should have a folder called gtfs-data, containing a file called routes.txt.
+This file can be obtained from by downloading gtfs.ovapi.nl/nl/gtfs-nl.zip and unzipping the file.
+
+# Start the script
+```
+bokeh serve main.py
+```
+
+# Usage
+Once the script is started, it can be accessed through localhost:5006.