Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
thiagosf committed Jul 1, 2015
1 parent 9d48312 commit c939dbb
Showing 1 changed file with 20 additions and 16 deletions.
36 changes: 20 additions & 16 deletions README.md
Expand Up @@ -4,12 +4,16 @@ With 38 different animations, two types of navigation and many options to custom

License: Dual licensed under the MIT or GPL Version 2

## Bower support

`bower install skitter-slideshow --save`

## How to install

### Add the CSS and JS files inside <head>

```html
<link type="text/css" href="css/skitter.styles.css" media="all" rel="stylesheet" />
<link type="text/css" href="css/skitter.styles.min.css" media="all" rel="stylesheet" />
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
<script type="text/javascript" src="js/jquery.easing.1.3.js"></script>
<script type="text/javascript" src="js/jquery.skitter.min.js"></script>
Expand All @@ -19,27 +23,27 @@ License: Dual licensed under the MIT or GPL Version 2

```javascript
$(document).ready(function() {
$(".box_skitter_large").skitter();
$(".box_skitter_large").skitter();
});
```

### Add the images through the unordered list

```html
<div class="box_skitter box_skitter_large">
<ul>
<li>
<a href="#cut"><img src="images/001.jpg" class="cut" /></a>
<div class="label_text"><p>cut</p></div>
</li>
<li>
<a href="#swapBlocks"><img src="images/002.jpg" class="swapBlocks" /></a>
<div class="label_text"><p>swapBlocks</p></div>
</li>
<li>
<a href="#swapBarsBack"><img src="images/003.jpg" class="swapBarsBack" /></a>
<div class="label_text"><p>swapBarsBack</p></div>
</li>
</ul>
<ul>
<li>
<a href="#cut"><img src="images/001.jpg" class="cut" /></a>
<div class="label_text"><p>cut</p></div>
</li>
<li>
<a href="#swapBlocks"><img src="images/002.jpg" class="swapBlocks" /></a>
<div class="label_text"><p>swapBlocks</p></div>
</li>
<li>
<a href="#swapBarsBack"><img src="images/003.jpg" class="swapBarsBack" /></a>
<div class="label_text"><p>swapBarsBack</p></div>
</li>
</ul>
</div>
```

0 comments on commit c939dbb

Please sign in to comment.