From 17782fc1f34b03d304743acb45ca4e0303187a19 Mon Sep 17 00:00:00 2001
From: Tanguy Herbron <tanguy.herbron@outlook.com>
Date: Mon, 1 Nov 2021 15:53:19 +0100
Subject: [PATCH] Update README with deployment instructions

---
 README.md | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 20da23c..d0b3b0a 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,20 @@
-# Wiki
+# Halia Wiki
+## Usage
+Wiki for the Halia infrastructure, powered by Bookstack.
 
-Wiki for the Halia infrastructure, powered by Bookstack
\ No newline at end of file
+## Requirements
+To deploy this instance, you only need to install `docker-compose` and `docker`.
+
+## Installation
+To deploy a copy of this instance, you might want to modify where the volumes are pointing to.
+
+Also, remember to copy `.env.sample` to `.env` and fill the variables according yo your setup.
+
+Then run
+
+```
+./start.sh
+```
+
+
+All necessary images should be downloaded automatically and the service should be started in the background.