From b7d20331b49d5b52b9a7cf44f34421831e775076 Mon Sep 17 00:00:00 2001 From: Anthony Smith Date: Tue, 29 Oct 2013 19:04:06 -0400 Subject: [PATCH] Added documentation for collections. --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cbc1ef1..2004dac 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ And publisher details: ## Usage ### Quick Search -Quick search allows you to perform searches based on title, topics, author or ISBN. +Quick search will allow you to perform searches based on title, topics, author or ISBN. Perform a quick search... ```ruby @@ -94,6 +94,19 @@ publisher.isbn ... ``` +### Collections +Collections will retrieve books lists. Examples include awards, state lists, etc. + +Retrieve a collection... +```ruby +results = ARBookFinder.collection({ 'Awards' => 'ALA Notable/Best Books' }) +``` + +Retrieve a collection with a multi-level hash... +```ruby +results = ARBookFinder.collection({ 'State Lists' => { 'Indiana' => 'IN Young Hoosier Middle Grades Book Award Nominees 2013-2014' } }) +``` + ### Pagination It's also possible to paginate search results. ```ruby