Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 54 lines (31 sloc) 3.884 kb
f16d3cc @adamstac Readme and Changelog updates, name set to animate-sass, set version to 0...
authored
1 # Animate.sass
87036dd @adamstac Initial commit
authored
2
09f96de @adamstac Readme updates
authored
3 Animate.sass is a Sass and Compass CSS animation library for WebKit, Firefox and beyond based on the work being done by [Dan Eden](https://github.com/daneden) in [Animate.css](http://daneden.me/animate/).
f16d3cc @adamstac Readme and Changelog updates, name set to animate-sass, set version to 0...
authored
4
5 The core of Animate.sass, despite being named "dot sass", is written in [SCSS](http://en.wikipedia.org/wiki/Scss). Don't hate.
87036dd @adamstac Initial commit
authored
6
7 ## Installation
8
f16d3cc @adamstac Readme and Changelog updates, name set to animate-sass, set version to 0...
authored
9 1. `gem install animate-sass`
10 2. Add `require 'animate-sass'` in Compass's `config.rb` file
5ebf21a @adamstac Enabled individual animation and animation family usage (not required to...
authored
11 3. Then `@import animate.sass` (all animations)
87036dd @adamstac Initial commit
authored
12
13 ## Usage
14
5ebf21a @adamstac Enabled individual animation and animation family usage (not required to...
authored
15 The usage is simple, `@import animate.sass` (loads all animations) and have fun. All Animate.css animations are supported.
09f96de @adamstac Readme updates
authored
16
17 Usage examples and documentation are in the works, but until then, check out the test project for help. Animate.sass is still in development and is not intended for production UNLESS you know what you are doing. Feedback and contributions are appreciated.
f16d3cc @adamstac Readme and Changelog updates, name set to animate-sass, set version to 0...
authored
18
5ebf21a @adamstac Enabled individual animation and animation family usage (not required to...
authored
19 ### Animations, a la carte ...
20
21 You may not want to load the full stack of animations from animate.sass, which emits over 5000+ lines of CSS. Instead you would like to pull in just a few animations or even a particular animation family. If that's the case, here's how to do that.
22
23 Rather than `@import animate.sass` (all animations), do this ...
24
25 First you need to import what's shared between all animations, `@import animate/shared`. Then you'll be able to import a full animation family or individual animations.
26
27 For example, if you wanted to use all the animations from the attention seekers animation family, and a few from the flippers animation family, here's what you'd do.
28
29 // Animate.sass shared stuffs
30 @import animate/shared
31
32 // Animate.sass animation families and individual animations
33 @import animate/animations/attention-seekers
34 @import animate/animations/flippers/flip
35 @import animate/animations/flippers/flipInX
36 @import animate/animations/flippers/flipOutX
37
f16d3cc @adamstac Readme and Changelog updates, name set to animate-sass, set version to 0...
authored
38 ## Credits and special thanks
39
a6e41ed @adamstac Readme updates to add to the thanks and credits
authored
40 Huge thanks to [Dan Eden](https://github.com/daneden) on his project [Animate.css](http://daneden.me/animate/). This project would not exist without his hard work. Thanks as well to Nick Pettit for his CSS3 animation library [Glide](https://github.com/nickpettit/glide).
09f96de @adamstac Readme updates
authored
41
a6e41ed @adamstac Readme updates to add to the thanks and credits
authored
42 Special thanks needs to also go out to [Thoughtbot](http://thoughtbot.com/) and [Bourbon](https://github.com/thoughtbot/bourbon). I borrowed some of their CSS3 animation mixins and "tailor fit" them to my needs.
09f96de @adamstac Readme updates
authored
43
44 Also, I want to thank [theCSSguru](https://twitter.com/theCSSguru) for kickstarting a Sass port of Animate.css. He has [a page out there](http://thecssguru.freeiz.com/animate/) linking to a simple Sass conversion of Animate.css, but I wanted to do a lot more with it for the Sass community. Since it wasn't hosted on GitHub, I took the liberty to start Animate.sass and begin carving it out.
87036dd @adamstac Initial commit
authored
45
46 ## License
47
f16d3cc @adamstac Readme and Changelog updates, name set to animate-sass, set version to 0...
authored
48 Copyright (c) 2011 Adam Stacoviak
87036dd @adamstac Initial commit
authored
49
50 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:
51
52 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
53
54 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.
Something went wrong with that request. Please try again.