README.md in ar_book_finder-1.0.0 vs README.md in ar_book_finder-1.1.0
- old
+ new
@@ -1,10 +1,10 @@
# ARBookFinder
Retrieve book data from [arbookfind.com](http://www.arbookfind.com)
-[](https://travis-ci.org/anthonator/ar-book-finder) [](https://gemnasium.com/anthonator/ar-book-finder) [](https://coveralls.io/r/anthonator/ar-book-finder) [](https://codeclimate.com/github/anthonator/ar-book-finder)
+[](http://badge.fury.io/rb/ar_book_finder) [](https://travis-ci.org/anthonator/ar-book-finder) [](https://gemnasium.com/anthonator/ar-book-finder) [](https://coveralls.io/r/anthonator/ar-book-finder) [](https://codeclimate.com/github/anthonator/ar-book-finder)
## Installation
Add this line to your application's Gemfile:
@@ -66,22 +66,22 @@
* page_count
## 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
results = ARBookFinder.search('harry potter')
results.page_count # Retrieve the number of pages this search returns
results.books # Retrieve the books returned on this page
```
Load book data on demand using ```#fetch```...
``` ruby
...
-book = results[0]
+book = results.book[0]
book.fetch # Retrieve book data
book.title
book.author
...
```
@@ -92,14 +92,27 @@
publisher.name
publisher.isbn
...
```
-### Pagination and Sorting
-It's also possible to paginate and sort search results.
+### 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
# Retrieve results for page 2 and sort on title
-results = ARBookFinder.Search('harry potter', 2, :title)
+results = ARBookFinder.search('harry potter', 2)
```
## Contributing
1. Fork it