README.md in algolia-2.0.0.pre.beta.3 vs README.md in algolia-2.0.0
- old
+ new
@@ -4,53 +4,61 @@
</a>
<h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your Ruby project</h4>
<p align="center">
- <a href="https://circleci.com/gh/algolia/algoliasearch-client-ruby/tree/release%2Fv2"><img src="https://circleci.com/gh/algolia/algoliasearch-client-ruby/tree/release%2Fv2.svg?style=shield" alt="CircleCI" /></a>
- <a href="https://rubygems.org/gems/algoliasearch"><img src="https://badge.fury.io/rb/algoliasearch.svg" alt="Gem Version"></a>
- <a href="https://rubygems.org/gems/algoliasearch"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="License"></a>
+ <a href="https://circleci.com/gh/algolia/algoliasearch-client-ruby"><img src="https://circleci.com/gh/algolia/algoliasearch-client-ruby/tree/release%2Fv2.svg?style=shield" alt="CircleCI" /></a>
+ <a href="https://rubygems.org/gems/algolia"><img src="https://badge.fury.io/rb/algoliasearch.svg" alt="Gem Version"></a>
+ <a href="https://rubygems.org/gems/algolia"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="License"></a>
</p>
</p>
<p align="center">
<a href="https://www.algolia.com/doc/api-client/getting-started/install/ruby/" target="_blank">Documentation</a> •
<a href="https://github.com/algolia/algoliasearch-rails" target="_blank">Rails</a> •
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
<a href="https://github.com/algolia/algoliasearch-client-ruby/issues" target="_blank">Report a bug</a> •
+ <a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/ruby/" target="_blank">FAQ</a> •
<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 `^1.8.7`.
+- Supports Ruby `^2.2`.
## 💡 Getting Started
First, install Algolia Ruby API Client via the [RubyGems](https://rubygems.org/) package manager:
```bash
-gem install algoliasearch
+gem install algolia
```
Then, create objects on your index:
```ruby
-Algolia.init(application_id: 'YourApplicationID',
- api_key: 'YourAPIKey')
-index = Algolia::Index.new('your_index_name')
+client = Algolia::Search::Client.create('YourApplicationID', 'YourAPIKey')
+index = client.init_index('your_index_name')
-index.save_objects([objectID: 1, name: 'Foo'])
+index.save_objects([objectID: 1, name: 'Foo'])
```
Finally, you may begin searching a object using the `search` method:
```ruby
-objects = index.search('Fo')
+objects = index.search('Foo')
```
For full documentation, visit the **[Algolia Ruby API Client](https://www.algolia.com/doc/api-client/getting-started/install/ruby/)**.
+
+## ❓ Troubleshooting
+
+Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/ruby/) where you will find answers for the most common issues and gotchas with the client.
+
+## Upgrade from V1 to V2
+
+If you were using the v1 and wish to update to v2, please follow our [Upgrade Guide](upgrade_guide.md)
## 📄 License
Algolia Ruby API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).