Documentation • Rails • Community Forum • Stack Overflow • Report a bug • FAQ • Support
## ✨ Features - Thin & minimal low-level HTTP client to interact with Algolia's API - Supports Ruby `^1.8.7`. ## 💡 Getting Started First, install Algolia Ruby API Client via the [RubyGems](https://rubygems.org/) package manager: ```bash gem install algoliasearch ``` Then, create objects on your index: ```ruby Algolia.init(application_id: 'YourApplicationID', api_key: 'YourAPIKey') index = Algolia::Index.new('your_index_name') index.save_objects([objectID: 1, name: 'Foo']) ``` Finally, you may begin searching a object using the `search` method: ```ruby objects = index.search('Fo') ``` 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. ## 📄 License Algolia Ruby API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).