Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
acrogenesis committed Oct 13, 2013
1 parent cf1e6f2 commit ccad5f3
Showing 1 changed file with 3 additions and 29 deletions.
32 changes: 3 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,6 @@ Well, technically it's Cretaceous proportions, but we'll let that slide for now.
Fixed version of Raptorize: A jQuery Plugin by Zurb
Original Raptorize jQuery Plugin http://zurb.com/playground/jquery-raptorize


Fixes
------------
This version fixes the need to use jQuery 1.4.3 or jQuery Migrate Plugin (Works with the neweset jQuery versions)
The Horrid spacing zurb had on the js file
Fixed Raptor being displayed when scrolling in iOS 5, 6

This package includes
------------
* An awesome Raptor Graphic courtesy of www.raptorize.com
Expand All @@ -29,36 +22,17 @@ How to use
------------

### What you need
First let's attach the scripts and activate the plugin in the footer of your document:
First let's attach the scripts in the footer of your document:

<script src="http://cdnjs.cloudflare.com/ajax/libs/jquery/2.0.3/jquery.js"></script>
<script src="jquery.raptorize.2.0.js"></script>
<script type="text/javascript">
$(window).load(function() {
$('.myButton').raptorize();
});
</script>

The only piece that you need to know here is that you need an anchor or element with the class 'myButton'. And there you have it, you're done!

### The Options

Raptorize can be activated on a click event, a timer which just fires after the page is loaded, or the Konami-Code (that is the default and what is have hooked up above but it only works once per page load).

<script type="text/javascript">
$(window).load(function() {
$('.button').raptorize({
'enterOn' : 'timer', //timer, konami-code, click
'delayTime' : 5000 //time before raptor attacks on timer mode
});
});
</script>


### Konami Code
`↑ ↑ ↓ ↓ ← → ← → B A`
Learn more about the Konami Code at https://en.wikipedia.org/wiki/Konami_Code

### Start using it by typing the Konami Code anywhere on your website

Contributing
------------

Expand Down

0 comments on commit ccad5f3

Please sign in to comment.