From d03f99061a11adab04b16f3d20e55f3657b25181 Mon Sep 17 00:00:00 2001
From: Kalle Westerling <kalle.westerling@gmail.com>
Date: Tue, 9 Jul 2024 11:51:50 +0100
Subject: [PATCH] Adding a simple README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..292e54f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# MapReader Examples
+
+A containerised application for testing out the MapReader library.
+
+## Creating the Docker image
+
+To create the Docker image, run the following command:
+
+```bash
+docker build -t mapreader-examples .
+```
+
+Note: This will take a while to complete as maps will be downloaded from the
+NLS. In our current tests, it takes ~30-35 minutes to complete.
+
+## Running the Docker container
+
+To run the Docker container, run the following command:
+
+```bash
+docker run -p 8888:8888 mapreader-examples
+```
+
+## Running the Docker container from Docker Hub
+
+To run the Docker container from Docker Hub, run the following command:
+
+```bash
+docker run -p 8888:8888 kallewesterling/mapreader-examples
+```