Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mwmitchell committed Feb 5, 2010
1 parent 984c80f commit c60300b
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.rdoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,11 @@ A set of helper methods/modules to assist in building Solr queries and handling
* {RSolr}[http://github.com/mwmitchell/rsolr]

==Requests
To use the RSolr::Ext connection instead of the normal RSolr connection:
solr = RSolr::Ext.connect
To use the RSolr::Ext connection instead of the normal RSolr connection just require 'rsolr-ext':
require 'rsolr-ext'
solr = RSolr.connect

RSolr::Ext adds a #find and a #luke_admin method to the connection object.
RSolr::Ext adds a #find and a #luke method to the connection object.

===#luke
The #luke method returns a Hash/Mash result of a /admin/luke?numTerms=0 request:
Expand Down Expand Up @@ -71,7 +72,8 @@ The #find method listens for certain keys. All other keys are ignored, allowing


==Request Example
solr = RSolr::Ext.connect
require 'rsolr-ext'
solr = RSolr.connect
solr_params = {
:page=>2,
:per_page=>10,
Expand All @@ -87,7 +89,8 @@ The #find method listens for certain keys. All other keys are ignored, allowing
==Responses
RSolr::Ext decorates the normal output hash from RSolr and adds some helpful methods.

solr = RSolr::Ext.connect
require 'rsolr-ext'
solr = RSolr.connect

response = solr.find :q=>'*:*'

Expand Down

0 comments on commit c60300b

Please sign in to comment.