From cba2182b2d9b7ad69b2648a05ecf52efca63cf58 Mon Sep 17 00:00:00 2001
From: Dale Davies <daledavies@users.noreply.github.com>
Date: Fri, 4 Feb 2022 12:16:47 +0000
Subject: [PATCH] Writing a project readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..aaf29c2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+
+# Jump
+
+Jump is yet another self-hosted startpage for your server, designed to be simple to set up and deploy.
+
+
+## Installation
+
+### Docker
+
+You can pull the daledavies/jump image direct from Docker Hub and use docker cli to run but my personal preference is docker-compose.
+
+The following will start Jump servinge on http://localhost:8123 with a custom site name, mapping the backgrounds and sites directory locally...
+
+```yaml
+version: '3'
+services:
+    web:
+        image: daledavies/jump
+        ports:
+            - 8123:8080
+        volumes:
+            - ./backgrounds:/var/www/html/assets/backgrounds
+            - ./sites:/var/www/html/sites
+        environment:
+            SITENAME: 'Custom site name'
+
+```
+