From d47b30b477698411f87a747069cf740f49c01bd3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Philipp=20H=C3=A4felfinger?= <philipp@haefelfinger.ch>
Date: Fri, 23 Sep 2022 23:08:52 +0200
Subject: [PATCH] updates readme

---
 README.md | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c786b71..6df895d 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,15 @@
 # piwigodocker
 
-docker compose to start a piwigo dev env
\ No newline at end of file
+Docker compose to start a piwigo environment to quickli test some things on local docker setup.
+
+To start a working piwigo gallery run the following commands:
+
+```
+git clone https://git.haefelfinger.net/piwigo/piwigodocker.git
+cd piwigodocker
+docker-compose up -d
+```
+
+All files gets created within the cloned directory and can be accessed easily from the host machine.
+
+Beware that the mariadb is exposed to localhost on port 3306 and is accessible from tools like mysql workbench or jetbrains datagrip.