superflux/lightbox/README.md

Lightbox2

The original lightbox script. Eight years later — still going strong!

Lightbox is small javascript library used to overlay images on top of the current page. It’s a snap to setup and works on all modern browsers.

• Demos and usage instructions. Visit the Lightbox homepage to see examples, info on getting started, script options, how to get help, and more.
• Releases and Changelog. Viewable on the Github Releases page
• Roadmap. View the Roadmap for a peek at what is being planned for future releases.
• License. Lightbox is licensed under the MIT License. Learn more about the license.

by Lokesh Dhakar

---

Info for Maintainers

• Issues and PRs requiring review. See items tagged with [status] needs review
• Questions on Stackoverflow. See Questions tagged with lightbox2.
• Release instructions. See DEPLOY.md.

Local development

• Install Bower and Grunt.
• Install jQuery dependency with Bower: bower install
• Start local server: grunt
• Navigate to localhost:8000/examples
• Update examples/index.html to load src/js/lightbox.js and jQuery.