turbolinks_transitions 0.0.1 → 0.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. data/README.md +20 -1
  2. data/lib/turbolinks_transitions.rb +0 -2
  3. metadata +1 -1
data/README.md CHANGED
@@ -18,7 +18,26 @@ Or install it yourself as:
18
18
 
19
19
  ## Usage
20
20
 
21
- TODO: Write usage instructions here
21
+ Just add the id `content` to your 'master div', for example, in your
22
+ `application.html.erb`:
23
+
24
+ ```erb
25
+ <div class="container" id="content">
26
+ <%= yield %>
27
+ </div>
28
+ ```
29
+
30
+ And import the JS:
31
+
32
+ ```coffeescript
33
+ #= require jquery
34
+ #= require jquery_ujs
35
+ #= require turbolinks
36
+ #= require turbolinks_transitions
37
+ #= require_tree .
38
+ ```
39
+
40
+ Thats it, you're now ready to roll.
22
41
 
23
42
  ## Contributing
24
43
 
@@ -1,5 +1,3 @@
1
- require "turbolinks_transitions/version"
2
-
3
1
  module TurbolinksTransitions
4
2
  module Rails
5
3
  class Engine < ::Rails::Engine
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: turbolinks_transitions
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.0.2
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors: