Sha256: fe7ed665f979b4c79d528135984fe3130f360c908db3f1087de34885170d61eb

Contents?: true

Size: 1.91 KB

Versions: 3

Compression:

Stored size: 1.91 KB

Contents

# jQuerySlickRails

[![Gem Version](https://badge.fury.io/rb/jquery-slick-rails.svg)](http://badge.fury.io/rb/jquery-slick-rails)
[![Build Status](https://travis-ci.org/bodrovis/jquery-slick-rails.svg?branch=master)](https://travis-ci.org/bodrovis/jquery-slick-rails)

A ruby gem that uses the Rails asset pipeline to include the jQuery Slick plugin by Ken Wheeler
(https://kenwheeler.github.io/slick/).

## Installation

Add this line to your application's Gemfile:

    gem "jquery-slick-rails"

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install jquery-slick-rails

NOTE: this is a jQuery plugin so you will also need the `jquery-rails` gem:

* https://github.com/rails/jquery-rails

## Usage

You will need to add this line into your `application.js`:

    //= require jquery.slick

Add

    @import 'slick';

into `application.scss` or

    /*
    [...]
    *= require slick
    [...]
    */

into `application.css`.

Starting from version **1.4.0** Slick provides an optional theme, so if you want to employ default styling, include
the following line:

    @import 'slick-theme';

into `application.scss` or

    /*
    [...]
    *= require slick-theme
    [...]
    */

into `application.css`.

You may use [this](https://github.com/bodrovis/jquery-slick-rails-demo) simple Rails app as an example.

## Testing

Run

    $ bundle install
    
and then

    $ rake test

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Make sure tests are passing
4. Commit your changes (`git commit -am 'Added some feature'`)
5. Push to the branch (`git push origin my-new-feature`)
6. Create new Pull Request

## License

This plugin is licensed under the [MIT License](https://github.com/bodrovis/jquery-slick-rails/blob/master/LICENSE.txt).

Copyright (c) 2015 [Ilya Bodrov](http://radiant-wind.com)

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
jquery-slick-rails-1.6.0.2 README.md
jquery-slick-rails-1.6.0.1 README.md
jquery-slick-rails-1.5.9.1 README.md