README.md in meilisearch-rails-0.9.1 vs README.md in meilisearch-rails-0.10.0
- old
+ new
@@ -4,21 +4,25 @@
<h1 align="center">Meilisearch Rails</h1>
<h4 align="center">
<a href="https://github.com/meilisearch/meilisearch">Meilisearch</a> |
+ <a href="https://www.meilisearch.com/pricing?utm_campaign=oss&utm_source=integration&utm_medium=meilisearch-rails">Meilisearch Cloud</a> |
<a href="https://docs.meilisearch.com">Documentation</a> |
<a href="https://discord.meilisearch.com">Discord</a> |
<a href="https://roadmap.meilisearch.com/tabs/1-under-consideration">Roadmap</a> |
<a href="https://www.meilisearch.com">Website</a> |
- <a href="https://docs.meilisearch.com/faq">FAQ</a>
+ <a href="https://www.meilisearch.com/docs/faq">FAQ</a>
</h4>
<p align="center">
<a href="https://github.com/meilisearch/meilisearch-rails/actions"><img src="https://github.com/meilisearch/meilisearch-rails/workflows/Tests/badge.svg" alt="Test"></a>
+ <a href="https://app.codecov.io/gh/meilisearch/meilisearch-rails/tree/main" >
+ <img src="https://codecov.io/gh/meilisearch/meilisearch-rails/branch/main/graph/badge.svg?token=9J7LRP11IR"/>
+ </a>
<a href="https://github.com/meilisearch/meilisearch-rails/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
- <a href="https://app.bors.tech/repositories/33032"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
+ <a href="https://ms-bors.herokuapp.com/repositories/68"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
</p>
<p align="center">⚡ The Meilisearch integration for Ruby on Rails 💎</p>
**Meilisearch Rails** is the Meilisearch integration for Ruby on Rails developers.
@@ -26,10 +30,11 @@
**Meilisearch** is an open-source search engine. [Learn more about Meilisearch.](https://github.com/meilisearch/meilisearch)
## Table of Contents <!-- omit in toc -->
- [📖 Documentation](#-documentation)
+- [⚡ Supercharge your Meilisearch experience](#-supercharge-your-meilisearch-experience)
- [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
- [🚀 Getting started](#-getting-started)
- [Compatibility](#-compatibility)
- [⚙️ Settings](#️-settings)
- [🔍 Custom search](#-custom-search)
@@ -56,19 +61,23 @@
## 📖 Documentation
The whole usage of this gem is detailed in this README.
-To learn more about Meilisearch, check out our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_started.html) or our [API References](https://docs.meilisearch.com/reference/api/).
+To learn more about Meilisearch, check out our [Documentation](https://www.meilisearch.com/docs/learn/tutorials/getting_started.html) or our [API References](https://www.meilisearch.com/docs/reference/api/).
+## ⚡ Supercharge your Meilisearch experience
+
+Say goodbye to server deployment and manual updates with [Meilisearch Cloud](https://www.meilisearch.com/pricing?utm_campaign=oss&utm_source=integration&utm_medium=meilisearch-rails). No credit card required.
+
## 🤖 Compatibility with Meilisearch
This package guarantees compatibility with [version v1.x of Meilisearch](https://github.com/meilisearch/meilisearch/releases/latest), but some features may not be present. Please check the [issues](https://github.com/meilisearch/meilisearch-rails/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3Aenhancement) for more info.
## 🔧 Installation <!-- omit in toc -->
-This package requires Ruby version 2.6.0 or later and Rails 5.2 or later.
+This package requires Ruby version 2.7.0 or later and Rails 6.1 or later. It may work in older versions but it is not officially supported.
With `gem` in command line:
```bash
gem install meilisearch-rails
```
@@ -80,11 +89,11 @@
gem 'meilisearch-rails'
```
### Run Meilisearch <!-- omit in toc -->
-There are many easy ways to [download and run a Meilisearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).
+There are many easy ways to [download and run a Meilisearch instance](https://www.meilisearch.com/docs/reference/features/installation.html#download-and-launch).
For example, if you use Docker:
```bash
docker pull getmeili/meilisearch:latest # Fetch the latest version of Meilisearch image from Docker Hub
@@ -106,10 +115,12 @@
}
```
The gem is compatible with [ActiveRecord](https://github.com/rails/rails/tree/master/activerecord), [Mongoid](https://github.com/mongoid/mongoid) and [Sequel](https://github.com/jeremyevans/sequel).
+⚠️ Note that even if you want to use all the default options, you must declare an empty `meilisearch` block in your model.
+
#### Add documents <!-- omit in toc -->
The following code will create a `Book` index and add search capabilities to your `Book` model.
```ruby
@@ -121,12 +132,14 @@
# all attributes will be sent to Meilisearch if block is left empty
end
end
```
-⚠️ Note that even if you want to use all the default options, you must declare an empty `meilisearch` block in your model.
+#### Automatic indexing
+As soon as you configure your model as mentioned above, `meilisearch-rails` will keep your database table data in sync with your Meilisearch instance using the `ActiveRecord` callbacks automatically.
+
#### Basic Backend Search <!-- omit in toc -->
We **strongly recommend the use of front-end search** through our [JavaScript API Client](https://github.com/meilisearch/meilisearch-js/) or [Instant Meilisearch plugin](https://github.com/meilisearch/instant-meilisearch)
Search returns ORM-compliant objects reloaded from your database.
@@ -189,14 +202,14 @@
pagination max_total_hits: 1000
end
end
```
-Check the dedicated section of the documentation, for more information on the [settings](https://docs.meilisearch.com/reference/features/settings.html).
+Check the dedicated section of the documentation, for more information on the [settings](https://www.meilisearch.com/docs/reference/api/settings#settings_parameters).
## 🔍 Custom search
-All the supported options are described in the [search parameters](https://docs.meilisearch.com/reference/features/search_parameters.html) section of the documentation.
+All the supported options are described in the [search parameters](https://www.meilisearch.com/docs/reference/api/search#search-parameters) section of the documentation.
```ruby
Book.search('Harry', attributes_to_highlight: ['*'])
```