Updated README, added example images to the doc folder.

README.md

@@ -1,3 +1,35 @@
-# module-galleries-nevena
+# Lewp module "nevena"
 
-A gallery containing of two containers. 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.
+## Description
+A gallery for desktop view consisting of two containers.
+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.
+
+## Available parameters
+
+| Key | Default value | Example value | Description |
+| ---- | ---- | ---- |---- |
+| start_landscape_id | | start-image-l100.jpg | The id of the picture that will be shown in the big image container in landscape orientation. |
+| start_portrait_id | | start-image-100.jpg | The id of the picture that will be shown in the big image container in portrait orientation. |
+| start_module_id | | another_module | The module id where the start images are stored. |
+| gallery_landscape_folder_id | | landscapes | The folder id where the landscape images are stored. |
+| gallery_portrait_folder_id | | portraits | The folder id where the portrait images are stored. |
+| image_extension | jpg | png | The image extension of the images to be used. |
+| orientation_priority | landscape | portrait | The image orientation that defines the stack. |
+
+## Behavior
+
+### 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.
+If it is not available, the landscape image will be used for the portrait image as well.
+Same the other way around, if "portrait" has been chosen.
+
+## Landscape example
+
+![Sample setup of nevena](doc/example-landscape.gif)
+
+## Portrait example
+
+![Sample setup of nevena](doc/example-portrait.gif)