readme.md
# Refinery CMS Image Slideshows
[](https://travis-ci.org/bisscomm/refinerycms-image-slideshows) [](https://codeclimate.com/github/bisscomm/refinerycms-image-slideshows) [](https://codeclimate.com/github/bisscomm/refinerycms-image-slideshows/coverage)
Image Slideshows engine for [Refinery CMS](http://refinerycms.com) allows you to display multiple slideshows.
### In summary you can:
* Manage slideshows (title, height, width, js config)
* Manage i18n slides in every slideshow (title, image, caption, body, link_url)
## Requirements
This version of `refinerycms-image_slideshows` supports Refinery 3.x and Rails 4.1+.
To use Rails 3.x / Refinery 2.0.x use the [refinerycms-image_slideshows "Refinery CMS 2-0 stable branch"](https://github.com/bisscomm/refinerycms-image-slideshows/tree/2-0-stable).
* [Refinery CMS](http://refinerycms.com) version 3.0.0 or above.
## Install
Open up your ``Gemfile`` and add at the bottom this line:
```ruby
gem 'refinerycms-image_slideshows', github: 'bisscomm/refinerycms-image-slideshows', branch: 'master'
```
Now, run ``bundle install``
Next, to install the products plugin run:
rails generate refinery:image_slideshows
Run database migrations:
rake db:migrate
Finally seed your database and you're done.
rake db:seed
## Usage
Add this code in your HTML) :
```html+erb
<body>
<% main_slideshow = Refinery::ImageSlideshows::ImageSlideshow.includes(:image_slides).find_by_title('Your Awesome Slideshow Title') %>
<div id="wrapper">
<div class="slider-wrapper">
<div id="slider">
<% main_slideshow.image_slides.each do |image_slide| %>
<%= link_to image_slide.link_url do %>
<%= image_tag image_slide.image.url, :alt => image_slide.title, :title => image_slide.caption %>
<% end %>
<% end %>
</div>
</div>
</div>
<script type="text/javascript">
$(window).load(function() {
$('#slider').nivoSlider({
<%= raw main_slideshow.js_config %>
});
});
</script>
</body>
```
## Developing & Contributing
The version of Refinery to develop this engine against is defined in the gemspec. To override the version of refinery to develop against, edit the project Gemfile to point to a local path containing a clone of refinerycms.
### Testing
Generate the dummy application to test against
$ bundle exec rake refinery:testing:dummy_app
Run the test suite with [Guard](https://github.com/guard/guard)
$ bundle exec guard start
Or just with rake spec
$ bundle exec rake spec
## More Information
* Check out our [Website](http://refinerycms.com/)
* Documentation is available in the [guides](http://refinerycms.com/guides)
* Questions can be asked on our [Google Group](http://group.refinerycms.org)