Skip to content

Commit 8e3dc24

Browse files
committed
improved documentation, added LICENSE.md file
1 parent 028dd71 commit 8e3dc24

4 files changed

Lines changed: 56 additions & 6 deletions

File tree

LICENSE.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright (c) 2017 Dan Dev
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,32 @@
1-
flexible-bootstrap-carousel
2-
===========================
1+
#flexible-bootstrap-carousel
32

43
Flexible Bootstrap Carousel plugin
54

5+
##Dependencies
6+
7+
```html
8+
<link rel="stylesheet" type="text/css" href="css/bootstrap.css" />
9+
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script>
10+
<script type="text/javascript" src="js/bootstrap.js"></script>
11+
```
12+
13+
##Using
14+
615
This plugin makes possible showing different numbers of items in your Bootstrap carousel depending on the window width. In fact it creates several columns in each item of a Bootstrap carousel. Then it is watching if the width of a browser window is changing and is adjusting number of columns in each item respectively to window's size (in this version of the plugin - from 1 through 3 columns).
716

8-
To initiate the plugin you just need to add a .flexible class name to some Bootstrap carousel in your html code
17+
To initiate the plugin you just need to add a *.flexible* class name to some Bootstrap carousel in your html code
918

19+
```html
1020
<div class="carousel flexible slide" data-ride="carousel" data-interval="5000" data-wrap="true">
1121
1222
//some stuff inside the carousel
1323
1424
</div>
25+
```
1526

16-
Then you need to create inside of the carousel a container with class name of .items. You also should put the items, which you want to appear in the carousel, into this container (each of them should have class of .item).
27+
Then you need to create inside of the carousel a container with class name of *.items*. You also should put the items, which you want to appear in the carousel, into this container (each of them should have class of *.item*).
1728

29+
```html
1830
<div class="carousel flexible slide" data-ride="carousel" data-interval="5000" data-wrap="true">
1931
<div class="items">
2032
<div class="flex-item">
@@ -56,7 +68,12 @@ Then you need to create inside of the carousel a container with class name of .i
5668
</a>
5769
5870
</div>
71+
```
72+
73+
You can leave empty container with class name of *.carousel-inner*.
74+
75+
You've done it! Enjoy of your page with built in flexible Bootstrap carousel.
5976

60-
Container that has class name of .carousel-inner can be empty.
77+
##License
6178

62-
You've done it! Enjoy of your page with built in flexible Bootstrap carousel.
79+
This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/DanDevG/flexible-bootstrap-carousel/master/LICENSE.md) file for details

flexible-bootstrap-carousel.css

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
/*!
2+
3+
Flexible Bootstrap Carousel v0.4
4+
5+
Copyright (c) 2017 Dan Dev
6+
7+
Released under the MIT license
8+
https://github.com/DanDevG/flexible-bootstrap-carousel/master/LICENSE.md
9+
10+
*/
11+
112
.carousel.flexible .items {
213
display: none;
314
}

flexible-bootstrap-carousel.js

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
/*!
2+
3+
Flexible Bootstrap Carousel v0.4
4+
5+
Copyright (c) 2017 Dan Dev
6+
7+
Released under the MIT license
8+
https://github.com/DanDevG/flexible-bootstrap-carousel/master/LICENSE.md
9+
10+
*/
11+
12+
13+
14+
15+
116
/* global $ */
217
/* global CustomEvent */
318

0 commit comments

Comments
 (0)