Skip to content

Commit

Permalink
Added documentation for collections.
Browse files Browse the repository at this point in the history
  • Loading branch information
Anthony Smith committed Oct 29, 2013
1 parent 871ea5e commit b7d2033
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit b7d2033

Please sign in to comment.