README.md in elasticsearch-api-0.4.11 vs README.md in elasticsearch-api-1.0.0.rc1
- old
+ new
@@ -52,21 +52,20 @@
require 'elasticsearch'
client = Elasticsearch::Client.new log: true
client.index index: 'myindex', type: 'mytype', id: 1, body: { title: 'Test' }
-# => {"_index"=>"myindex", ... "created"=>true}
+# => {"ok"=>true, "_index"=>"myindex", ...}
client.search index: 'myindex', body: { query: { match: { title: 'test' } } }
# => {"took"=>2, ..., "hits"=>{"total":5, ...}}
```
-Full documentation and examples are included as RDoc annotations in the source code
-and available online at <http://rubydoc.info/gems/elasticsearch-api>.
+Full documentation is available at <http://rubydoc.info/gems/elasticsearch-api>.
### Usage with a custom client
-When you want to mix the library into your own client, it must conform to a following _contract_:
+When you want to mix the library into you own client, it must conform to a following _contract_:
* It responds to a `perform_request(method, path, params, body)` method,
* the method returns an object with `status`, `body` and `headers` methods.
A simple client could look like this: