Merge branch 'main' into change-indexes-method

Author: nagaroni

README.md

@@ -78,17 +78,17 @@ require 'meilisearch'
 client = MeiliSearch::Client.new('http://127.0.0.1:7700', 'masterKey')
 
 # An index is where the documents are stored.
-index = client.index('books')
+index = client.index('movies')
 
 documents = [
-  { book_id: 123,  title: 'Pride and Prejudice' },
-  { book_id: 456,  title: 'Le Petit Prince' },
-  { book_id: 1,    title: 'Alice In Wonderland' },
-  { book_id: 1344, title: 'The Hobbit' },
-  { book_id: 4,    title: 'Harry Potter and the Half-Blood Prince' },
-  { book_id: 42,   title: 'The Hitchhiker\'s Guide to the Galaxy' }
+  { id: 1, title: 'Carol', genres: ['Romance', 'Drama'] },
+  { id: 2, title: 'Wonder Woman', genres: ['Action', 'Adventure'] },
+  { id: 3, title: 'Life of Pi', genres: ['Adventure', 'Drama'] },
+  { id: 4, title: 'Mad Max: Fury Road', genres: ['Adventure', 'Science Fiction'] },
+  { id: 5, title: 'Moana', genres: ['Fantasy', 'Action']},
+  { id: 6, title: 'Philadelphia', genres: ['Drama'] },
 ]
-# If the index 'books' does not exist, MeiliSearch creates it when you first add the documents.
+# If the index 'movies' does not exist, MeiliSearch creates it when you first add the documents.
 index.add_documents(documents) # => { "updateId": 0 }
 ```
 
@@ -100,20 +100,20 @@ With the `updateId`, you can check the status (`enqueued`, `processing`, `proces
 
 ``` ruby
 # MeiliSearch is typo-tolerant:
-puts index.search('harry pottre')
+puts index.search('carlo')
 ```
 Output:
 
 ```ruby
 {
   "hits" => [{
-    "book_id" => 4,
-    "title" => "Harry Potter and the Half-Blood Prince"
+    "id" => 1,
+    "title" => "Carol"
   }],
   "offset" => 0,
   "limit" => 20,
   "processingTimeMs" => 1,
-  "query" => "harry pottre"
+  "query" => "carlo"
 }
 ```
 
@@ -123,7 +123,7 @@ All the supported options are described in the [search parameters](https://docs.
 
 ```ruby
 index.search(
-  'hob',
+  'wonder',
   attributesToHighlight: ['*']
 )
 ```
@@ -134,18 +134,18 @@ JSON output:
 {
     "hits": [
         {
-            "book_id": 1344,
-            "title": "The Hobbit",
+            "id": 2,
+            "title": "Wonder Woman",
             "_formatted": {
-                "book_id": 1344,
-                "title": "The <em>Hob</em>bit"
+                "id": 2,
+                "title": "<em>Wonder</em> Woman"
             }
         }
     ],
     "offset": 0,
     "limit": 20,
     "processingTimeMs": 0,
-    "query": "hob"
+    "query": "wonder"
 }
 ```