Sha256: 270bf0c86b178f0c367ba2dbe532e2e4da55fc5c74cf61c04606f64bde1f7e41

Contents?: true

Size: 669 Bytes

Versions: 61

Compression:

Stored size: 669 Bytes

Contents

= Picky Client

== Usage

1. Define a client instance, and save it (as an example) in a constant:
   
   <tt>FullSearch = Picky::Client::Full.new :host => 'some_host', :port => 1234, :path => '/path/to/search'</tt>
   
2. Use it in your controllers to search:
   
   <tt>result = FullSearch.search :query => 'some query', :offset => 123 # This gets you a hash</tt>
   
3. Then, to make access easier (if needed):
   
   <tt>result.extend Picky::Convenience</tt>
   
4. This gets you the following methods on result:
   
   * <tt>empty?</tt>
   * <tt>ids(limit=20)</tt>
   * <tt>clear_ids</tt>
   * <tt>allocations</tt>
   * <tt>allocations_size</tt>
   * <tt>total</tt>

Version data entries

61 entries across 61 versions & 1 rubygems

Version Path
picky-client-1.5.4 README.rdoc
picky-client-1.5.3 README.rdoc
picky-client-1.5.2 README.rdoc
picky-client-1.5.1 README.rdoc
picky-client-1.5.0 README.rdoc
picky-client-1.4.3 README.rdoc
picky-client-1.4.2 README.rdoc
picky-client-1.4.1 README.rdoc
picky-client-1.4.0 README.rdoc
picky-client-1.3.4 README.rdoc
picky-client-1.3.3 README.rdoc
picky-client-1.3.2 README.rdoc
picky-client-1.3.1 README.rdoc
picky-client-1.3.0 README.rdoc
picky-client-1.2.4 README.rdoc
picky-client-1.2.3 README.rdoc
picky-client-1.2.2 README.rdoc
picky-client-1.2.1 README.rdoc
picky-client-1.2.0 README.rdoc
picky-client-1.1.7 README.rdoc