Merge branch 'master' into searchResposne-type-definitions

Author: Nick-Mazuk

.code-samples.meilisearch.yaml

@@ -61,20 +61,15 @@ update_settings_1: |-
       ],
       distinctAttribute: 'movie_id',
       searchableAttributes: [
-          'uid',
-          'movie_id',
           'title',
           'description',
-          'poster',
-          'release_date',
-          'rank'
+          'genre'
       ],
       displayedAttributes: [
           'title',
           'description',
-          'poster',
-          'release_date',
-          'rank'
+          'genre',
+          'release_date'
       ],
       stopWords: [
           'the',
@@ -129,21 +124,20 @@ get_searchable_attributes_1: |-
   client.index('movies').getSearchableAttributes()
 update_searchable_attributes_1: |-
   client.index('movies').updateSearchableAttributes([
-      'title',
-      'description',
-      'uid'
+    'title',
+    'description',
+    'genre',
   ])
 reset_searchable_attributes_1: |-
   client.index('movies').resetSearchableAttributes()
 get_displayed_attributes_1: |-
   client.index('movies').getDisplayedAttributes()
 update_displayed_attributes_1: |-
   client.index('movies').updateDisplayedAttributes([
-      'title',
-      'description',
-      'release_date',
-      'rank',
-      'poster'
+    'title',
+    'description',
+    'genre',
+    'release_date',
   ])
 reset_displayed_attributes_1: |-
   client.index('movies').resetDisplayedAttributes()
@@ -159,24 +153,19 @@ distinct_attribute_guide_1: |-
   client.index('jackets').updateSettings({ distinctAttribute: 'product_id' })
 field_properties_guide_searchable_1: |-
   client.index('movies').updateSettings({
-        searchableAttributes: [
-            'uid',
-            'movie_id',
-            'title',
-            'description',
-            'poster',
-            'release_date',
-            'rank'
-        ]
-    })
+    searchableAttributes: [
+        'title',
+        'description',
+        'genre'
+    ]
+  })
 field_properties_guide_displayed_1: |-
   client.index('movies').updateSettings({
       displayedAttributes: [
           'title',
           'description',
-          'poster',
-          'release_date',
-          'rank'
+          'genre',
+          'release_date'
       ]
   })
 filtering_guide_1: |-
@@ -266,32 +255,27 @@ settings_guide_distinct_1: |-
 settings_guide_searchable_1: |-
   client.index('movies').updateSettings({
     searchableAttributes: [
-      'uid',
-      'movie_id',
       'title',
       'description',
-      'poster',
-      'release_date',
-      'rank'
+      'genre'
     ]
   })
 settings_guide_displayed_1: |-
   client.index('movies').updateSettings({
     displayedAttributes: [
       'title',
       'description',
-      'poster',
+      'genre',
       'release_date',
-      'rank'
     ]
   })
 add_movies_json_1: |-
   const movies = require('./movies.json')
   index.addDocuments(movies).then((res) => console.log(res))
 documents_guide_add_movie_1: |-
   index.addDocuments([{
-    "movie_id": "123sq178",
-    "title": "Amelie Poulain"
+    'movie_id': '123sq178',
+    'title': 'Amelie Poulain'
   }])
 search_guide_1: |-
   client.index('movies').search('shifu', {
@@ -302,29 +286,22 @@ search_guide_2: |-
   client.index('movies').search('Avengers', {
     filters: 'release_date > 795484800',
   })
-getting_started_create_index_md: |-
+getting_started_add_documents_md: |-
   ```bash
   $ npm install meilisearch
   # or
   $ yarn add meilisearch
   ```
 
-  ```javascript
+  ```js
   const MeiliSearch = require('meilisearch')
+  const movies = require('./movies.json')
 
   const client = new MeiliSearch({ host: 'http://127.0.0.1:7700' })
-  const index = client
-    .createIndex('movies')
+  client.index('movie').addDocuments(movies)
     .then((res) => console.log(res))
   ```
 
-  [About this package](https://github.com/meilisearch/meilisearch-js/)
-getting_started_add_documents_md: |-
-  ```js
-  const movies = require('./movies.json')
-  index.addDocuments(movies).then((res) => console.log(res))
-  ```
-
   [About this package](https://github.com/meilisearch/meilisearch-js/)
 getting_started_search_md: |-
   ```js

README.md

@@ -7,10 +7,9 @@
 <h4 align="center">
   <a href="https://github.com/meilisearch/MeiliSearch">MeiliSearch</a> |
   <a href="https://docs.meilisearch.com">Documentation</a> |
+  <a href="https://slack.meilisearch.com">Slack</a> |
   <a href="https://roadmap.meilisearch.com/tabs/1-under-consideration">Roadmap</a> |
   <a href="https://www.meilisearch.com">Website</a> |
-  <a href="https://blog.meilisearch.com">Blog</a> |
-  <a href="https://twitter.com/meilisearch">Twitter</a> |
   <a href="https://docs.meilisearch.com/faq">FAQ</a>
 </h4>
 
@@ -19,13 +18,14 @@
   <a href="https://github.com/meilisearch/meilisearch-js/actions"><img src="https://github.com/meilisearch/meilisearch-js/workflows/Tests/badge.svg" alt="Tests"></a>
   <a href="https://github.com/prettier/prettier"><img src="https://img.shields.io/badge/styled_with-prettier-ff69b4.svg" alt="Prettier"></a>
   <a href="https://github.com/meilisearch/meilisearch-js/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
-  <a href="https://slack.meilisearch.com"><img src="https://img.shields.io/badge/slack-MeiliSearch-blue.svg?logo=slack" alt="Slack"></a>
   <a href="https://app.bors.tech/repositories/28762"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
 </p>
 
 <p align="center">⚡ The MeiliSearch API client written for JavaScript</p>
 
-**MeiliSearch JavaScript** is the MeiliSearch API client for JavaScript developers. **MeiliSearch** is a powerful, fast, open-source, easy to use and deploy search engine. Both searching and indexing are highly customizable. Features such as typo-tolerance, filters, and synonyms are provided out-of-the-box.
+**MeiliSearch JavaScript** is the MeiliSearch API client for JavaScript developers.
+
+**MeiliSearch** is an open-source search engine. [Discover what MeiliSearch is!](https://github.com/meilisearch/MeiliSearch)
 
 ## Table of Contents <!-- omit in toc -->
 
@@ -271,7 +271,7 @@ controller.abort()
 
 ## 🤖 Compatibility with MeiliSearch
 
-This package only guarantees the compatibility with the [version v0.17.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.17.0).
+This package only guarantees the compatibility with the [version v0.18.1 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.18.1).
 
 ## 💡 Learn More
 

yarn.lock

@@ -5000,9 +5000,9 @@ rollup-plugin-typescript2@^0.29.0:
     tslib "2.0.1"
 
 rollup@^2.2.0:
-  version "2.35.1"
-  resolved "https://registry.yarnpkg.com/rollup/-/rollup-2.35.1.tgz#e6bc8d10893556a638066f89e8c97f422d03968c"
-  integrity sha512-q5KxEyWpprAIcainhVy6HfRttD9kutQpHbeqDTWnqAFNJotiojetK6uqmcydNMymBEtC4I8bCYR+J3mTMqeaUA==
+  version "2.36.1"
+  resolved "https://registry.yarnpkg.com/rollup/-/rollup-2.36.1.tgz#2174f0c25c7b400d57b05628d0e732c7ae8d2178"
+  integrity sha512-eAfqho8dyzuVvrGqpR0ITgEdq0zG2QJeWYh+HeuTbpcaXk8vNFc48B7bJa1xYosTCKx0CuW+447oQOW8HgBIZQ==
   optionalDependencies:
     fsevents "~2.1.2"