Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
luis-almeida committed Mar 22, 2012
1 parent 265776a commit 8f2be61
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Expand Up @@ -6,6 +6,7 @@ Filtrify is an advanced tag filtering plugin, inspired by [Chosen](http://harves
Advanced because you can search tags within tags and filter items by multiple tags from different categories and get a live feedback on the number of items containing related tags.



### How?
Filtrify makes use of the new HTML5 "data" attribute to store the metadata.
All you have to do is for each item in your list, include a "data" attribute with the respective tags (metadata). If you have more than one category of tags, include them in another "data" attribute. You can add as much categories of tags as you need.
Expand All @@ -15,6 +16,7 @@ The plugin instanciation is very simple, you just have to pass a "containerID" a
Visit filtrify [project page](http://luis-almeida.github.com/filtrify/) to read the documentation.



### Demos
- [Single category](http://luis-almeida.github.com/filtrify/music.html)
- [Multiple categories](http://luis-almeida.github.com/filtrify/movies.html)
Expand All @@ -25,12 +27,15 @@ Visit filtrify [project page](http://luis-almeida.github.com/filtrify/) to read
- [Reset all filters](http://luis-almeida.github.com/filtrify/reset.html)
- [Close panel after adding a tag](http://luis-almeida.github.com/filtrify/close.html)
- [Block "data" attributes from being added as categories](http://luis-almeida.github.com/filtrify/block.html)
- [Decrease page load with jPages and Lazy Load](http://luis-almeida.github.com/filtrify/jPages.html)
- [Load images with Lazy Load](http://luis-almeida.github.com/filtrify/lazyload.html)
- [Add pagination with jPages](http://luis-almeida.github.com/filtrify/jpages.html)



#### Browser compatibility (tested):
IE7 (buggy); IE8+, Chrome, Firefox, Opera and Safari (current versions - tested!)



#### Release log:
First release - v0.1 (22.03.2012)

0 comments on commit 8f2be61

Please sign in to comment.