Merge branch 'master' of https://github.com/thexmanxyz/Owl-Carousel-N…

…eo-Gantry

README.md

@@ -62,14 +62,21 @@ Please be aware that the template folder path varies in dependence of the used C
 1. Go to your Gantry templating backend (e.g. Extensions/Templates).
 2. Switch to **Layout** and add the new appearing Particle called **Owl Carousel Neo** either globally to your site (**base outline**), to a specific template or page by dragging it to the designated section.
 3. Configure the appearance according to your favor.
+
+Many of the provided options are directly passed over to the [OwlCarousel2 API](https://owlcarousel2.github.io/OwlCarousel2/docs/api-options.html). Please check out the link to find out more about the available options.
+
+Please also take a look at the [OwlCarousel2 demo page ](https://owlcarousel2.github.io/OwlCarousel2/demos/demos.html) which provides many useful hints on how the carousel plugin works. Many of the existing options are already included in **Owl Carousel Neo** but if you are desperately missing a feature. Please [open an issue](https://github.com/thexmanxyz/Owl-Carousel-Neo-Gantry/issues/new) with your feature request.
+
+If you need a list of all supported API [options](https://owlcarousel2.github.io/OwlCarousel2/docs/api-options.html) for the responsive mode of the carousel, please [visit this page](https://owlcarousel2.github.io/OwlCarousel2/demos/responsive.html) and scroll to the bottom.
 
 ## Supported Parameters, Particle Options and Features
 * All settings of the original Particle are included and compatible
 * Updated to latest version of [Owl Carousel 2](https://owlcarousel2.github.io/OwlCarousel2/)
+* Supports most of the [API options](https://owlcarousel2.github.io/OwlCarousel2/docs/api-options.html) offered by Owl Carousel 2
 * Four new basic alignment styles for the slider
 * Two themes (black or white) for the new styles
 * Default Helium style with many additional settings (dots, navigation and text)
-* Lazy loading of images included
+* Lazy and responsive loading of images included
 * Timing of slides (annual or one-time)
 * Seven different control colors (independently per control type)
 * Dot navigation alignment
@@ -91,6 +98,13 @@ Please be aware that the template folder path varies in dependence of the used C
   * Asynchronous
   * Deferred
 
+If you need more information on how Owl Carousel 2 works please mind also these resources:
+ * [General Documentation](https://owlcarousel2.github.io/OwlCarousel2/docs/started-welcome.html)
+ * [API Options](https://owlcarousel2.github.io/OwlCarousel2/docs/api-options.html)
+ * [Demo Page](https://owlcarousel2.github.io/OwlCarousel2/demos/demos.html)
+
+Most of the settings outlined within the API options are also supported by this Particle. Even though some of them are named differently to reflect their real behavior. Please also check the field descriptions in the Particle which offer more information about each option.
+
 ## Showroom
 Insight of the *Owl Carousel Neo - Gantry Particle* configuration:
 
@@ -99,35 +113,43 @@ Insight of the *Owl Carousel Neo - Gantry Particle* configuration:
 ![1](/screenshots/backend_general.png)
 
 
-**Backend (2)** - *[Appearance](/screenshots/backend_appearance.png)*
+**Backend (2)** - *[Look](/screenshots/backend_look.png)*
+
+![2](/screenshots/backend_look.png)
+
+
+**Backend (3)** - *[Behavior](/screenshots/backend_behavior_1.png)*
+
+![3](/screenshots/backend_behavior_1.png)
 
-![2](/screenshots/backend_appearance.png)
 
+**Backend (4)** - *[Behavior Responsive](/screenshots/backend_behavior_2.png)*
 
-**Backend (3)** - *[Behavior](/screenshots/backend_behavior.png)*
+![4](/screenshots/backend_behavior_2.png)
 
-![3](/screenshots/backend_behavior.png)
+**Backend (5)** - *[Animate](/screenshots/backend_animate.png)*
 
+![5](/screenshots/backend_animate.png)
 
-**Backend (4)** - *[Controls](/screenshots/backend_controls.png)*
+**Backend (6)** - *[Controls](/screenshots/backend_controls.png)*
 
-![4](/screenshots/backend_controls.png)
+![6](/screenshots/backend_controls.png)
 
-**Backend (5)** - *[Slides (1)](/screenshots/backend_slides1.png)*
+**Backend (7)** - *[Slides (1)](/screenshots/backend_slides1.png)*
 
-![5](/screenshots/backend_slides1.png)
+![7](/screenshots/backend_slides1.png)
 
-**Backend (6)** - *[Slides (2)](/screenshots/backend_slides2.png)*
+**Backend (8)** - *[Slides (2)](/screenshots/backend_slides2.png)*
 
-![6](/screenshots/backend_slides2.png)
+![8](/screenshots/backend_slides2.png)
 
-**Backend (7)** - *[Timing](/screenshots/backend_timing.png)*
+**Backend (9)** - *[Timing](/screenshots/backend_timing.png)*
 
-![7](/screenshots/backend_timing.png)
+![9](/screenshots/backend_timing.png)
 
-**Backend (8)** - *[API](/screenshots/backend_api.png)*
+**Backend (10)** - *[API](/screenshots/backend_api.png)*
 
-![8](/screenshots/backend_api.png)
+![10](/screenshots/backend_api.png)
 ___
 
 A few example configurations which show the new design of the Particle:
@@ -163,7 +185,7 @@ A few example configurations which show the new design of the Particle:
 ![15](/screenshots/frontend_demo7.png)
 
 ## Future Tasks
-- [ ] Include `aria` attributes for links
+- [ ] Add more OwlCarousel2 API options / events / callbacks if necessary.
 
 ## Known Issues
 None