README.md in routemaster-drain-2.3.0 vs README.md in routemaster-drain-2.4.0

- old
+ new

@@ -236,10 +236,24 @@ response = client.discover('https://identity.deliveroo.com.dev') session_create_response = response.sessions.create(email: 'test@test.com', password: 'sup3rs3cr3t') session_create_response.user.show(1) ``` +The index method returns an Enumerable response to fetch all items in a paginated collection with the options of passing filters. + +``` +users = response.users +user_index_response = users.index(filters: {first_name: 'Jeff'}) +total_users = user_index_response.total_users + +puts "printing names of all #{total_users} users" +user_index_response.each do |user| + puts user.full_name +end +``` + + ### HATEOAS materialisation The client comes with optional HATEOAS response capabilities. They are optional, because drain itself doesn't need to use the HATEOAS response capabilities. Whenever the client is used outside of the drain it is **strongly** advised to be used with the HATEOAS response capabilities. The HATEOAS response will materialize methods based on the keys found under the `_links` key on the payload. The semantics are the following: @@ -313,5 +327,10 @@ 1. Fork it ( http://github.com/deliveroo/routemaster-drain/fork ) 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`) 4. Push to the branch (`git push origin my-new-feature`) 5. Create new Pull Request + +Do not bump version numbers on branches (a maintainer will do this when cutting +a release); but please do describe your changes in the `CHANGELOG` (at the top, +without a version number). +