README.rdoc in rsolr-0.12.0 vs README.rdoc in rsolr-0.12.1
- old
+ new
@@ -1,23 +1,14 @@
=RSolr
-A Ruby client for Apache Solr. RSolr has been developed to be simple and extendable. It features transparent JRuby DirectSolrConnection support and a simple Hash-in, Hash-out architecture.
+A simple, extensible Ruby client for Apache Solr.
== Installation:
gem sources -a http://gemcutter.org
sudo gem install rsolr
-==Related Resources & Projects
-* {Solr}[http://lucene.apache.org/solr/]
-* {RSolr Google Group}[http://groups.google.com/group/rsolr]
-* {RSolr::Ext}[http://github.com/mwmitchell/rsolr-ext] -- an extension kit for RSolr
-* {Sunspot}[http://github.com/outoftime/sunspot] -- an awesome Solr DSL, built with RSolr
-* {Blacklight}[http://blacklightopac.org] -- a next generation Library OPAC, built with RSolr
-* {solr-ruby}[http://wiki.apache.org/solr/solr-ruby] -- the original Solr Ruby Gem
-* {java_bin}[http://github.com/kennyj/java_bin] -- Provides javabin/binary parsing for Ruby
-
-== Simple usage:
+== Example:
require 'rubygems'
require 'rsolr'
solr = RSolr.connect :url=>'http://solrserver.com'
# send a request to /select
@@ -35,27 +26,27 @@
:q=>'washington',
:start=>0,
:rows=>10
})
-The params sent into the method are sent to Solr as-is. The one exception is if a value is an array. When an array is used, multiple parameters are generated for the Solr query. Example:
+The params sent into the method are sent to Solr as-is. The one exception is if a value is an array. When an array is used, multiple parameters *with the same name* are generated for the Solr query. Example:
solr.select :q=>'roses', :fq=>['red', 'violet']
The above statement generates this Solr query:
?q=roses&fq=red&fq=violet
Use the #request method for a custom request handler path:
response = solr.request '/documents', :q=>'test'
-A shortcut for the above example:
+A shortcut for the above example use a method call instead:
response = solr.documents :q=>'test'
== Updating Solr
-Updating can be done using native Ruby structures. Hashes are used for single documents and arrays are used for a collection of documents (hashes). These structures get turned into simple XML "messages". Raw XML strings can also be used.
+Updating uses native Ruby structures. Hashes are used for single documents and arrays are used for a collection of documents (hashes). These structures get turned into simple XML "messages". Raw XML strings can also be used.
Raw XML via #update
solr.update '</commit>'
solr.update '</optimize>'
@@ -108,6 +99,31 @@
response = solr.select :q=>'*:*'
response.raw[:status_code]
response.raw[:body]
response.raw[:url]
-The raw is a hash that contains the generated params, url, path, post data, headers etc., very useful for debugging and testing.
+The raw is a hash that contains the generated params, url, path, post data, headers etc., very useful for debugging and testing.
+
+==Related Resources & Projects
+* {RSolr Google Group}[http://groups.google.com/group/rsolr] -- The RSolr discussion group
+* {rsolr-ext}[http://github.com/mwmitchell/rsolr-ext] -- An extension kit for RSolr
+* {rsolr-direct}[http://github.com/mwmitchell/rsolr-direct] -- JRuby direct connection for RSolr
+* {SunSpot}[http://github.com/outoftime/sunspot] -- An awesome Solr DSL, built with RSolr
+* {Blacklight}[http://blacklightopac.org] -- A "next generation" Library OPAC, built with RSolr
+* {java_bin}[http://github.com/kennyj/java_bin] -- Provides javabin/binary parsing for RSolr
+* {Solr}[http://lucene.apache.org/solr/] -- The Apache Solr project
+* {solr-ruby}[http://wiki.apache.org/solr/solr-ruby] -- The original Solr Ruby Gem!
+
+== Note on Patches/Pull Requests
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history
+ (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+==Contributors
+* mperham
+* Mat Brown
+* shairontoledo
+* Matthew Rudy
+* Fouad Mardini
\ No newline at end of file