README.md in bento_search-0.0.1 vs README.md in bento_search-0.5.0
- old
+ new
@@ -1,13 +1,13 @@
# BentoSearch
[![Build Status](https://secure.travis-ci.org/jrochkind/bento_search.png)](http://travis-ci.org/jrochkind/bento_search)
+(Fairly robust and stable at this point, but still pre-1.0 release, may
+be some breaking api changes before 1.0, but probably not too many, it's
+looking pretty good).
-(**in progress*, not yet ready for use, mainly because we need more
-out of the box search engines supported).
-
bento_search provides an abstraction/normalization layer for querying and
displaying results for external search engines, in Ruby on Rails. Requires
Rails3 and tested only under ruby 1.9.3.
* It is focused on use cases for academic libraries, but may be useful in generic
@@ -35,13 +35,18 @@
provider, so you can switch out the search provider, minimizing dependent
code in your app that needs to be rewritten. As well as letting you get
started quick without reinventing the wheel and figuring out poorly
documented vendor API's yourself.
+See code-level api documentation for more details, especially at
+BentoSearch::SearchEngine. http://rubydoc.info/gems/bento_search/frames/
-## Usage
+An example app using BentoSearch and showing it's features is
+available at http://github.com/jrochkind/sample_megasearch
+## Usage Examples
+
### Instantiate an engine, and search
When you instantiate an engine, you can provide configuration keys. There
are a few standard keys (see BentoSearch::SearchEngine), and others that
may be engine-specific. Some engine-specific keys (such as api auth keys)
@@ -243,12 +248,12 @@
BentoSearch.register_engine("something") do |conf|
conf.engine = SomeEngine
conf.item_decorators = [ SomeModule, OtherModule]
end
-See BentoSearch::Item for more information on decorators, and BentoSearch::Link
-on links.
+See BentoSearch::Link for more info on links. (TODO: Better docs/examples
+on decorators).
## Planned Features
I am trying to keep BentoSearch as simple as it can be to conveniently meet
actual use cases. Trying to avoid premature over-engineering, and pave
@@ -287,11 +292,12 @@
To re-generate cached responses, delete the relevant files in
`./test/vcr_cassettes` and re-run tests. You may have to set an ENV
variable with your own API keys to re-run tests without cached response
like this.
-Also note `./test/support/mock_engine.rb`, a simple mock/dummy SearchEngine
-implementation that can be used in other tests.
+Also note `BentoSearch::MockEngine`, a simple mock/dummy SearchEngine
+implementation that can be used in other tests, including in client
+software where convenient.
Pull requests welcome. Pull requests with additional search engine implementations
welcome. See more info on writing a BentoSearch::SearchEngine in the inline
docs in that file.