<commit_before># Superslides 0.2.3

Superslides is a full screen slider for jQuery heavily influenced by <NAME>' [SlidesJS](https://github.com/nathansearles/slides/). It's designed to be as flexible as possible, while maintaining a reasonable code base and good browser compatibility.

It is 2kb minified (4.5kb uncompressed).

# Usage
[Check out the demo](http://nicinabox.github.com/superslides/) for a complete example. Basic usage is as follows. See options below for things you can change. 

    $('#slides').superslides(options_hash)

# Options

Currently, Superslides has a few configurable options: auto play with a delay, slide transition speed, and slide easing ([jQueryUI](http://jqueryui.com/) or the [jQuery easing plugin](http://gsgd.co.uk/sandbox/jquery/easing/) required).

Listed as `option: default_value`  

    delay: 5000
    play: false
    slide_speed: 'normal'
    slide_easing: 'linear'
    nav_class: 'slides-navigation'
    
# Events

Superslides triggers a few events that you can bind to (listed in the order they are fired):

    slides.initialized
    slides.animated
    
When the window is resized and on first load before `slides.initialized`:

    slides.image_adjusted
    slides.sized
    
Binding to events:

    $('body').on('slides.initialized', '#slides', function(){
      console.log('Superslides initialized')
    })

You can also start and stop the slider by triggering the respective events:

    $('#slides').trigger('slides.start')
    $('#slides').trigger('slides.stop')

# Markup

Markup is pretty straightforward. At minimum it looks like this:

    <div id="slides">
      <div class="slides-container">
        <img src="http://flickholdr.com/1000/800" width="1000" height="800" alt="">
        <img src="http://flickholdr.com/1000/800" width="1000" height="800" alt="">
      </div>
    </div>

### A note on scaling images

Be sure to include the height and width attributes of the image in it's original size! These attributes will be removed when the slider is initialized, but they are needed to quickly and simply calculate the original image dimensions.

    <div id="slides">
      <ul class="slides-container">
        <li>
          <img src="http://flickholdr.com/1000/800" width="1000" height="800" alt="">
          <div class="container">
            Slide one
          </div>
        </li>
        <li>
          <img src="http://flickholdr.com/1000/800/space" width="1000" height="800" alt="">
          <div class="container">
            Slide two
          </div>
        </li>
        <li>
          <img src="http://flickholdr.com/1000/800/tech" width="1000" height="800" alt="">
          <div class="container">
            Slide three
          </div>
        </li>
      </ul>
      <nav class="slides-navigation">
        <a href="#" class="next">Next</a>
        <a href="#" class="prev">Previous</a>
      </nav>
    </div>

# CSS

Not _all_ of these styles are required, but most of them are. They've been written with much of the styling removed, and only the basic structural elements left in place. That said, it's likely you may need to tweak to your needs.

    #slides {
      overflow: hidden;
      width: 100%;
      height: 100%;
    }
    #slides .slides-navigation {
      width: 988px;
      margin: 0 auto;
      position: relative;
      z-index: 3;
      top: -50%;
    }
    #slides img {
      max-width: none;
      min-width: 100%;
      min-height: 100%;
      position: absolute;
    }
    #slides .slides-navigation a {
      position: absolute;
      display: block;
    }
    #slides .slides-navigation a.prev {
      left: 0;
    }
    #slides .slides-navigation a.next {
      right: 0;
    }
    /* The following is optional based on your markup */
    #slides .slides-container {
      margin: 0;
      padding: 0;
      list-style: none;
      position: relative;
    }
    #slides .slides-container li {
      margin: 0;
      padding: 0;
      float: left;
      position: relative;
      background: none;
    }
    #slides ul li.current {
      display: block;
      z-index: 1;
    }
    #slides ul li .container {
      width: 988px;
      margin: 0 auto;
      position: relative;
      top: 38%;
      background: none;
    }

# Hardware Acceleration

Superslides is compatible with the [jQuery Animate Enhanced](http://playground.benbarnett.net/jquery-animate-enhanced/) plugin. Simply include it before this plugin and it will automatically smooth out the transitions with CSS animations.

# Contributing

If you'd like to contribute by fixing bugs, adding features, or otherwise, you should know that Superslides is written in [Coffeescript](http://coffeescript.org/) with [Jasmine](http://pivotal.github.com/jasmine/) and [Jasmine Headless Webkit](http://johnbintz.github.com/jasmine-headless-webkit/). Write a test for your feature and submit a pull request :)

# Known Bugs & Caveats

* IE 7 & 8 don't scale the image nicely<commit_msg>Add MIT License to readme<commit_after># Superslides 0.2.3

Superslides is a full screen slider for jQuery heavily influenced by <NAME>les' [SlidesJS](https://github.com/nathansearles/slides/). It's designed to be as flexible as possible, while maintaining a reasonable code base and good browser compatibility.

It is 2kb minified (4.5kb uncompressed).

# Usage
[Check out the demo](http://nicinabox.github.com/superslides/) for a complete example. Basic usage is as follows. See options below for things you can change.

    $('#slides').superslides(options_hash)

# Options

Currently, Superslides has a few configurable options: auto play with a delay, slide transition speed, and slide easing ([jQueryUI](http://jqueryui.com/) or the [jQuery easing plugin](http://gsgd.co.uk/sandbox/jquery/easing/) required).

Listed as `option: default_value`

    delay: 5000
    play: false
    slide_speed: 'normal'
    slide_easing: 'linear'
    nav_class: 'slides-navigation'

# Events

Superslides triggers a few events that you can bind to (listed in the order they are fired):

    slides.initialized
    slides.animated

When the window is resized and on first load before `slides.initialized`:

    slides.image_adjusted
    slides.sized

Binding to events:

    $('body').on('slides.initialized', '#slides', function(){
      console.log('Superslides initialized')
    })

You can also start and stop the slider by triggering the respective events:

    $('#slides').trigger('slides.start')
    $('#slides').trigger('slides.stop')

# Markup

Markup is pretty straightforward. At minimum it looks like this:

    <div id="slides">
      <div class="slides-container">
        <img src="http://flickholdr.com/1000/800" width="1000" height="800" alt="">
        <img src="http://flickholdr.com/1000/800" width="1000" height="800" alt="">
      </div>
    </div>

### A note on scaling images

Be sure to include the height and width attributes of the image in it's original size! These attributes will be removed when the slider is initialized, but they are needed to quickly and simply calculate the original image dimensions.

    <div id="slides">
      <ul class="slides-container">
        <li>
          <img src="http://flickholdr.com/1000/800" width="1000" height="800" alt="">
          <div class="container">
            Slide one
          </div>
        </li>
        <li>
          <img src="http://flickholdr.com/1000/800/space" width="1000" height="800" alt="">
          <div class="container">
            Slide two
          </div>
        </li>
        <li>
          <img src="http://flickholdr.com/1000/800/tech" width="1000" height="800" alt="">
          <div class="container">
            Slide three
          </div>
        </li>
      </ul>
      <nav class="slides-navigation">
        <a href="#" class="next">Next</a>
        <a href="#" class="prev">Previous</a>
      </nav>
    </div>

# CSS

Not _all_ of these styles are required, but most of them are. They've been written with much of the styling removed, and only the basic structural elements left in place. That said, it's likely you may need to tweak to your needs.

    #slides {
      overflow: hidden;
      width: 100%;
      height: 100%;
    }
    #slides .slides-navigation {
      width: 988px;
      margin: 0 auto;
      position: relative;
      z-index: 3;
      top: -50%;
    }
    #slides img {
      max-width: none;
      min-width: 100%;
      min-height: 100%;
      position: absolute;
    }
    #slides .slides-navigation a {
      position: absolute;
      display: block;
    }
    #slides .slides-navigation a.prev {
      left: 0;
    }
    #slides .slides-navigation a.next {
      right: 0;
    }
    /* The following is optional based on your markup */
    #slides .slides-container {
      margin: 0;
      padding: 0;
      list-style: none;
      position: relative;
    }
    #slides .slides-container li {
      margin: 0;
      padding: 0;
      float: left;
      position: relative;
      background: none;
    }
    #slides ul li.current {
      display: block;
      z-index: 1;
    }
    #slides ul li .container {
      width: 988px;
      margin: 0 auto;
      position: relative;
      top: 38%;
      background: none;
    }

# Hardware Acceleration

Superslides is compatible with the [jQuery Animate Enhanced](http://playground.benbarnett.net/jquery-animate-enhanced/) plugin. Simply include it before this plugin and it will automatically smooth out the transitions with CSS animations.

# Contributing

If you'd like to contribute by fixing bugs, adding features, or otherwise, you should know that Superslides is written in [Coffeescript](http://coffeescript.org/) with [Jasmine](http://pivotal.github.com/jasmine/) and [Jasmine Headless Webkit](http://johnbintz.github.com/jasmine-headless-webkit/). Write a test for your feature and submit a pull request :)

# Known Bugs & Caveats

* IE 7 & 8 don't scale the image nicely

# MIT License

Copyright (C) 2012 <NAME> (aka, <NAME>)

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:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

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.
{'fraction_non_alphanumeric': 0.10857713974195893, 'fraction_numerical': 0.021079411230238054, 'mean_word_length': 2.889399293286219, 'pattern_counts': {'":': 0, '<': 69, '<?xml version=': 0, '>': 69, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1709949', 'n_tokens_mistral': 3440, 'n_tokens_neox': 3171, 'n_words': 1177}