README.md in reso_api-0.3.1 vs README.md in reso_api-0.4.0
- old
+ new
@@ -141,10 +141,27 @@
```ruby
client.properties(expand: "Media")
```
-#### Pagination, $top, and $skip
+#### Automatically iterate over all results
+
+By passing a block to Media, Member, Office, and Property resource calls, subsequent paginated calls will automatically be made until the whole result set has been traversed. The block provided is executed for each returned object hash.
+
+Here are a couple of examples of how that can be used:
+
+```ruby
+client.properties(filter: "StandardStatus eq 'Active'") do |hash|
+ puts "#{hash['ListingKey']} – #{hash['UnparsedAddress']}"
+end
+
+client.properties(filter: "StandardStatus eq 'Active'") do |hash|
+ Listing.create(listing_key: hash['ListingKey'], data: hash)
+end
+```
+
+
+#### Manually iterate over all results
The default number of results returned is 100. You can override the default limit using the `$top` parameter. The higher the number specific for `$top`, the longer the API response will take, and pay attention to that different services does enforce a cap for number of records returned.
You can paginate through multiple sets of results using `$skip`, this can help you process multiple records quickly. In addition, if you use `$select` to target only certain fields, the API response time will be faster.