Skip to content

Commit

Permalink
fixed errors in readme + cleaned up code
Browse files Browse the repository at this point in the history
  • Loading branch information
francesko committed Apr 19, 2013
1 parent ff946bf commit 845ead9
Show file tree
Hide file tree
Showing 6 changed files with 1,339 additions and 1,349 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ Backbone.Facetr is a plugin which enables filtering of Backbone collections thro
It works flawlessly up to 2500 items; computation starts getting slower with 5000 - 10000 items. This is however an
early version; optimizations may improve performance in future realeases.

If you decide to use Facetr on one of your projects, contact us, we would be glad to add the link to your project in the [examples](#examples) section.


### <a name="installation"></a> INSTALLATION

Expand Down Expand Up @@ -220,7 +222,7 @@ example
##### <a name="facetcollection-facet"></a> facet(dotNotationExpr:string, [operator:string]) : Facet

Adds a Facet on the given collection using the property refered to by the
Dot Notation expression (See Dot Notation section for more details).
Dot Notation expression (see [Dot Notation section](#dot-notation) for more details).
Valid operator values are: 'or' and 'and' (anything else will default to 'and').
Returns the created Facet instance to allow method chaining.
Triggers a facet event with the facetName passed to the callback.
Expand Down Expand Up @@ -377,7 +379,7 @@ event unless true is passed as parameter.

example

Facetr(collection).sortBy('Age').asc();
Facetr(collection).sortBy('Age').desc();


##### <a name="facetcollection-addfilter"></a> addFilter(filterName:string, filter:function, [silent:boolean]) : FacetCollection
Expand Down
Loading

0 comments on commit 845ead9

Please sign in to comment.