+
+This is an Angular wrapper library for the [Swiper](http://idangero.us/swiper/). To use this library you should get familiar with the Swiper documentation as well since this documentation only explains details specific to this wrapper.
+
+This documentation is for the latest 6.x.x version which requires Angular 5 or newer. For Angular 4 you need to use the latest 4.x.x version. Documentation for the 4.x.x can be found from here.
+
+### Quick links
+
+[Example application](https://zefoy.github.io/ngx-swiper-wrapper/)
+ |
+[StackBlitz example](https://stackblitz.com/github/zefoy/ngx-swiper-wrapper/tree/master)
+ |
+[Swiper documentation](http://idangero.us/swiper/api/)
+
+### Building the library
+
+```bash
+npm install
+npm run build
+```
+
+### Running the example
+
+```bash
+npm install
+npm run start
+```
+
+### Installing and usage
+
+```bash
+npm install ngx-swiper-wrapper --save
+```
+
+##### Load the module for your app (with global configuration):
+
+Providing the global configuration is optional and when used you should only provide the configuration in your root module.
+
+```javascript
+import { SwiperModule } from 'ngx-swiper-wrapper';
+import { SWIPER_CONFIG } from 'ngx-swiper-wrapper';
+import { SwiperConfigInterface } from 'ngx-swiper-wrapper';
+
+const DEFAULT_SWIPER_CONFIG: SwiperConfigInterface = {
+ direction: 'horizontal',
+ slidesPerView: 'auto'
+};
+
+@NgModule({
+ ...
+ imports: [
+ ...
+ SwiperModule
+ ],
+ providers: [
+ {
+ provide: SWIPER_CONFIG,
+ useValue: DEFAULT_SWIPER_CONFIG
+ }
+ ]
+})
+```
+
+##### Use it in your HTML template (with custom configuration):
+
+This library provides two ways to create a Swiper element, component for simple use cases and directive for more custom use cases.
+
+**COMPONENT USAGE**
+
+Simply replace the element that would ordinarily be passed to `Swiper` with the swiper component.
+
+**NOTE:** Component provides default elements for the scrollbar, navigation and pagination which you can enable by setting the appropriate configuration to 'true' or by using the default selector. If you want to use custom elements then you might want to use the directive instead.
+
+```html
+