diff --git a/README.md b/README.md index 7575a986..664bfe5e 100644 --- a/README.md +++ b/README.md @@ -108,6 +108,8 @@ MeiliSearch::Rails.configuration = { 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 The following code will create a `Book` index and add search capabilities to your `Book` model. @@ -123,7 +125,9 @@ class Book < ActiveRecord::Base 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