Permalink
Browse files

Update the Readme.

  • Loading branch information...
1 parent 4ccc5fc commit 5433b64dcd0353560f665bdd8714f722b2c66df8 @joe-goullaud joe-goullaud committed Dec 5, 2012
Showing with 31 additions and 1 deletion.
  1. +31 −1 README.md
View
@@ -1,4 +1,34 @@
RZCollectionList
================
+A framework for transforming and combining data from Core Data and other sources and displaying it in a UITableView or UICollectionView.
-A framework for dealing with displaying data from Core Data and other sources in UITableViews.
+## Collection Lists
+### Basic Lists
+#### RZArrayCollectionList
+A basic list that provides sectioning for an array of objects. It also allows mutation of the sections and objects.
+
+#### RZFetchedCollectionList
+A basic list that wraps an NSFetchedResultsController and implements the NSFetchedResultsControllerDelegate protocol, passing along the content change notifications to the collection list observers.
+
+### Transformable Lists
+#### RZFilteredCollectionList
+A transformable list that filters a source list using an NSPredicate.
+
+#### RZSortedCollectionList
+A transformable list that sorts a source list using an array of NSSortDescriptors.
+
+#### RZCompositeCollectionList
+A transformable list that combines an array of source lists into a single collection list.
+
+## Collection List Data Sources
+#### RZCollectionListTableViewDataSource
+A data source object that takes an RZCollectionList and makes it the data source of a UITableView.
+
+#### RZCollectionListCollectionViewDataSource (TODO)
+A data source object that takes an RZCollectionList and makes it the data source of a UICollectionView.
+
+## Examples
+Check out the Demo Project in RZCollectionList-Demo for examples of how to use each type of collection list.
+
+## License
+RZCollectionList is distributed under an [MIT License](http://opensource.org/licenses/MIT). See the LICENSE file for more details.

0 comments on commit 5433b64

Please sign in to comment.