README.md in algolia-2.3.4 vs README.md in algolia-3.0.0.alpha.2
- old
+ new
@@ -22,12 +22,11 @@
<a href="https://www.algolia.com/support" target="_blank">Support</a>
</p>
## ✨ Features
-- Thin & minimal low-level HTTP client to interact with Algolia's API
-- Supports Ruby `^2.4`.
+Thin & minimal low-level HTTP client to interact with Algolia's API
## 💡 Getting Started
First, install Algolia Ruby API Client via the [RubyGems](https://rubygems.org/) package manager:
```bash
@@ -36,18 +35,17 @@
Then, create objects on your index:
```ruby
-client = Algolia::Search::Client.create('YourApplicationID', 'YourAPIKey')
-index = client.init_index('your_index_name')
+client = Algolia::SearchClient.create('YourApplicationID', 'YourAPIKey')
-index.save_objects([{objectID: 1, name: 'Foo'}])
+client.save_object('your_index_name', {objectID: 1, name: 'Foo'})
```
Finally, you may begin searching a object using the `search` method:
```ruby
-objects = index.search('Foo')
+objects = client.search_single_index('your_index_name', 'Foo')
```
For full documentation, visit the **[Algolia Ruby API Client](https://www.algolia.com/doc/api-client/getting-started/install/ruby/)**.
## ❓ Troubleshooting