README.md in turbolinks-animate-1.1.0 vs README.md in turbolinks-animate-1.2.0
- old
+ new
@@ -21,11 +21,11 @@
---
## Installation
-`turbolinks-animate` works with Rails 4.0 onwards. You can add it to your `Gemfile` with:
+`turbolinks-animate` works with Rails 5 onwards. You can add it to your `Gemfile` with:
```ruby
gem 'turbolinks-animate'
```
@@ -49,11 +49,11 @@
```js
//= require turbolinks-animate
$(document).on( 'turbolinks:load', function() {
- $('body').turbolinksAnimate();
+ $('body.turbolinks-animate').turbolinksAnimate();
turbolinksAnimateAppear();
});
$(document).on( 'turbolinks:request-start', function() {
turbolinksAnimateDisappear();
});
@@ -64,23 +64,27 @@
```scss
@import "animate"
```
+**Note:** When using a package manager like Yarn, make sure to fetch the latest version instead:
+
+```
+$ yarn install turbolinks-animate
+```
+
To use turbolinks-animate, replace the `body` tag in your layout with the `turbolinks_animate_body` view helper:
```ruby
= turbolinks_animate_body class: 'custom-class' do
= yield
```
-In your controller simply include the `TurbolinksAnimateHelper` module, and specify your animation.
+In your controller simply the animation:
```ruby
class WelcomeController < ApplicationController
- include TurbolinksAnimateHelper
-
def index
turbolinks_animate 'fadein'
end
def more
@@ -92,9 +96,10 @@
[Here](https://github.com/jonhue/turbolinks-animate.js) are more details about the usage of turbolinks-animate.js.
## To Do
[Here](https://github.com/jonhue/turbolinks-animate/projects/1) is the full list of current projects.
+
To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/turbolinks-animate/issues/new).
---
## Contributing