README.md in bento_search-0.5.0 vs README.md in bento_search-0.6.0
- old
+ new
@@ -11,11 +11,11 @@
Rails3 and tested only under ruby 1.9.3.
* It is focused on use cases for academic libraries, but may be useful in generic
cases too. Initially, engine adapters are planned to be provided for:
Google Books, Scopus, SerialSolutions Summon, Ex Libris Primo,
-EBSCO Discovery Service, and EBSCO traditional 'EIT' api. Most
+EBSCO Discovery Service, EBSCO traditional 'EIT' api, Google Site Search. Most
of these search engines require a vendor license to use.
* bento_search could be considered building blocks for a type of 'federated
search' functionality, but it does not and will never support merging results
from multiple engines into one result set. It is meant to support displaying the
@@ -40,10 +40,11 @@
See code-level api documentation for more details, especially at
BentoSearch::SearchEngine. http://rubydoc.info/gems/bento_search/frames/
An example app using BentoSearch and showing it's features is
available at http://github.com/jrochkind/sample_megasearch
+There is a short screencast showing that sample app in action here: http://screencast.com/t/JLS0lclrBZU
## Usage Examples
### Instantiate an engine, and search
@@ -102,24 +103,24 @@
google_books_engine.search("smith", :semantic_earch_field => :title)
This will raise if an engine doesn't support that semantic search field.
You can find out what fields a particular engine supports.
- BentoSearch::GoogleBooksEngine.search_keys # => internal keys
- BentoSearch::GoogleBooksEngine.semantic_search_keys
+ google_books_engine.search_keys # => internal keys
+ google_books_engine.semantic_search_keys
You can also provide all arguments in a single hash when it's convenient
to do so:
google_books_engine.search(:query => "smith", :search_field => "inauthor")
### Sorting
An engine advertises what sort types it supports:
- BentoSearch::GoogleBooksEngine.sort_definitions
+ google_books_engine.sort_keys
-That returns a hash, where the keys are sort identifiers, where possible
+An array of sort identifiers, where possible
chosen from a standard list of semantics. (See list in config/i18n/en.yml,
bento_search.sort_keys).
google_books_engine.search("my query", :sort => "date_desc")