Permalink
Browse files

update docs

  • Loading branch information...
1 parent faf4e1e commit e9f3f3865ce81193ca7482420c57d14d807511b9 @defunkt committed Feb 22, 2011
Showing with 8 additions and 7 deletions.
  1. +8 −7 README.md
View
@@ -22,18 +22,15 @@ This release relies on a lot of advanced CSS techniques (box-shadow, border-radi
## Usage
-Include jQuery, `src/facebox.js` and `src/facebox.css`. Then tell facebox where you've put `src/loading.gif` and `src/closelabel.png`
+Include jQuery, `src/facebox.js` and `src/facebox.css`.
- $.facebox.settings.closeImage = '/images/facebox/closelabel.png'
- $.facebox.settings.loadingImage = '/images/facebox/loading.gif'
-
-Calling facebox() on any anchor tag will do the trick, it's easier to give your Faceboxy links a rel="facebox" and hit them all onDomReady.
+Calling facebox() on any anchor tag will do the trick, but it's easier to give your Faceboxy links a rel="facebox" and hit them all onDomReady.
jQuery(document).ready(function($) {
$('a[rel*=facebox]').facebox()
})
-Any anchor links with `rel="facebox"` with now automatically use facebox:
+Any anchor links with `rel="facebox"` with now automatically use Facebox:
<a href="#terms" rel="facebox">Terms</a>
Loads the #terms div in the box
@@ -45,7 +42,7 @@ Any anchor links with `rel="facebox"` with now automatically use facebox:
Loads the terms.png image in the box
-### Using facebox programmatically
+### Using Facebox programmatically
jQuery.facebox('some html')
jQuery.facebox('some html', 'my-groovy-style')
@@ -91,6 +88,10 @@ You can give the facebox container an extra class (to fine-tune the display of t
<a href="remote.html" rel="facebox[.bolder]">text</a>
+You can also use Facebox with acustom loading graphic:
+
+ $.facebox.settings.loadingImage = '/images/ajax/loading.gif'
+
## Contact & Help
If you have questions, feel free to ask on the [Google Groups Mailing List](http://groups.google.com/group/facebox/). Alternatively if you find a bug, you can [open an issue](http://github.com/defunkt/facebox/issues).

0 comments on commit e9f3f38

Please sign in to comment.