From 14343c448ac7d57c2b092e390d5f4120f2f3a6ba Mon Sep 17 00:00:00 2001
From: Lewin Probst <info@emirror.de>
Date: Wed, 7 Aug 2019 11:31:17 +0200
Subject: [PATCH] Updated README.

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

diff --git a/README.md b/README.md
index a4aecb9..36b0203 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,28 @@ The first is displaying the current image, the second one shows the other
 images. The current image is switched with the one that has been clicked on in
 the second container.
 
+## Installation
+In the terminal, go either to the global module or site module level of your hierarchy.
+Then invoke the following command.
+```bash
+git clone git@gitlab.com:lewp/modules-galleries-nevena.git modules/galleries/nevena
+```
+
+## Configuration
+In your page file, add the following command to add the module to your page.
+```php
+$this->addModule(
+    "galleries_nevena",
+    [
+        "start_landscape_id" => $this->getPageId()."_l100.jpg",
+        "start_portrait_id" => $this->getPageId()."_p100.jpg",
+        "start_module_id" => "backgroundpicture",
+        "gallery_landscape_folder_id" => $this->getPageId()."_landscapes",
+        "gallery_portrait_folder_id" => $this->getPageId()."_portraits"
+    ]
+);
+```
+
 ## Available parameters
 
 | Key | Default value | Example value | Description |
@@ -20,6 +42,13 @@ the second container.
 
 ## Behavior
 
+### Image folders
+The images can be stored either in the global or the site module level, depending
+on your application.
+
+The images require to be in the resources/images folder in the nevena module folder,
+the parameter ids are given relative to this folder.
+
 ### Orientation priority
 If "landscape" has been chosen, the gallery_landscape_folder_id specifies the image stack that is being used.
 The module checks then every image for its counter part in the portrait folder given as parameter.