README.textile in riddle-1.4.0 vs README.textile in riddle-1.5.0

- old
+ new

@@ -20,16 +20,16 @@ To get started, just instantiate a Client object: client = Riddle::Client.new # defaults to localhost and port 3312 client = Riddle::Client.new "sphinxserver.domain.tld", 3333 # custom settings - + And then set the parameters to what you want, before running a query: client.match_mode = :extended client.query "Pat Allan @state Victoria" - + The results from a query are similar to the other clients - but here's the details. It's a hash with the following keys: * :matches * :fields @@ -51,11 +51,11 @@ documents. The key @:attributes@ will return a hash of attribute name and type pairs, and @:words@ returns a hash of hashes representing the words from the search, with the number of documents and hits for each, along the lines of: results[:words]["Pat"] #=> {:docs => 12, :hits => 15} - + @:total@, @:total_found@ and @:time@ return the number of matches available, the total number of matches (which may be greater than the maximum available), and the time in milliseconds that the query took to run. @:status@ is the error code for the query - and if there was a related warning, it will be under @@ -89,5 +89,7 @@ * Jason Lambert * Saberma * James Cook * Alexey Artamonov * Paul Gibler +* Ngan Pham +* Aaron Gilbralter