diff options
| -rw-r--r-- | README.md | 10 |
1 files changed, 7 insertions, 3 deletions
@@ -1,7 +1,6 @@ wedge ===== - -A drop-dead simple lightbox written in Typescript +A drop-dead simple lightbox written in Typescript. [Demo](http://matthewsot.github.com/wedge/Demo) Wedge can display images, YouTube videos, and divs easily. @@ -38,4 +37,9 @@ There are even more complicated animations (like ScaleAnimation and RotateAnimat And if you don't like a default, you can customize just about any part of the lightbox through parameters: ``` initWedge(link: 'some-div-id', type: 'div', title: 'title', animator: new ScaleAnimation(), exitOnEscape: true, doAutoPosition: true, opacity: 0.8, allowExit: true, overlayId: 'overlay-id', contentId: 'content-container-id'); -```
\ No newline at end of file +``` + +## Dependencies +jQuery is the only requirement to use Wedge.js, which contains the basic lightbox and two animations (FadeAnimation and SlideAnimation). + +If you'd like to use the animations in Animations.js (such as ScaleAnimation and RotateAnimation), you'll need to add the jquery.gsap plugin to your site. Instructions for that can be found [here](http://www.greensock.com/jquery-gsap-plugin/).
\ No newline at end of file |