Skip to content

Commit

Permalink
docu and api
Browse files Browse the repository at this point in the history
  • Loading branch information
reiz committed Apr 4, 2012
1 parent 216ed3e commit 8ec0ed5
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,25 @@ Because the default sort method does not recognize the numbers in the string. Th
This GEM has 8 methods

`Naturalsorter::Sorter.sort(array, caseinsesitive)`

`Naturalsorter::Sorter.sort_desc(array, caseinsesitive)`

And this here for more advanced sorting. Where you can put in a array of objects and the method which should called on every object for comparison.

`Naturalsorter::Sorter.sort_by_method(array, method, caseinsesitive)`

`Naturalsorter::Sorter.sort_by_method_desc(array, method, caseinsesitive)`

This methods are based on a different algo. spezially optimizied for sorting version strings.

`Naturalsorter::Sorter.sort_version(array)`

`Naturalsorter::Sorter.sort_version_desc(array)`

This here is again for an array with objects.

`Naturalsorter::Sorter.sort_version_by_method(array, method)`

`Naturalsorter::Sorter.sort_version_by_method_desc(array)`

Get newest.
Expand Down

0 comments on commit 8ec0ed5

Please sign in to comment.