Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Added license and started documentation

  • Loading branch information...
commit 54665f6ea2d3bf555b99c31a1286c3b40cb79b61 1 parent cd2c9da
@Prinzhorn authored
Showing with 51 additions and 0 deletions.
  1. +21 −0 LICENSE.txt
  2. +30 −0 README.md
View
21 LICENSE.txt
@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2012 Alexander Prinzhorn (@Prinzhorn)
+
+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:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+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.
View
30 README.md
@@ -0,0 +1,30 @@
+skrollr
+======
+
+**Parallax scrolling** lib with **zero dependencies** in just under **6k minified**. No JavaScript skills needed.
+
+
+Documentation
+======
+
+Abstract
+------
+
+skrollr allows you to animate any css property of any element depending on the horizontal scrollbar.
+
+All you need to do is define keyframes for each element at certain points in --time-- top offset. Each keyframe consists of one or multiple css properties and values.
+
+
+JavaScript
+------
+
+On the JavaScript part there's not much todo. So if you only know CSS and HTMl, perfect.
+
+All there is to do is calling ```skrollr.init([options]);```
+
+
+HTML
+------
+
+TODO
+
Please sign in to comment.
Something went wrong with that request. Please try again.