Document QuerySet extensions

Author: kylef

README.md

@@ -1,7 +1,30 @@
 # RxQueryKit
 
+[RxSwift]() extensions for QueryKit.
+
 ## Usage
 
+### QuerySet
+
+RxQueryKit extends QueryKit and provides methods to evaluate and execute
+operations as observables.
+
+```swift
+let queryset = Person.queryset(context).filter(Person.age > 25)
+```
+
+```swift
+queryset.objects().subscribeNext {
+  print($0)
+}
+```
+
+```swift
+queryset.count().subscribeNext {
+  print("There are now \($0) people who are more than 25.")
+}
+```
+
 ### Managed Object Context
 
 RxQueryKit provides extensions on managed object context to observe when the

RxQueryKit/RxQueryKit.swift

@@ -3,13 +3,18 @@ import RxSwift
 import QueryKit
 
 
+/// Extension to QuerySet to provide observables
 extension QuerySet {
+  /// Performs a query for all objects matching the set predicate ordered by any set sort descriptors.
+  /// Emits a value with an array of all objects when the managed object context is changed.
   func objects() throws -> Observable<[ModelType]> {
     return context.qk_objectsDidChange().map { [unowned self] notification in
       return try self.array()
     }.startWith(try self.array())
   }
 
+  /// Performs a query for the count of all objects matching the set predicate.
+  /// Emits an Int containing the amount of objects matching the predicate and updates when the managed object context is changed.
   func count() throws -> Observable<Int> {
     return context.qk_objectsDidChange().map { [unowned self] notification in
       return try self.count()