Fix merge conflicts

Author: bidoubiwa

.github/release-draft-template.yml

@@ -25,3 +25,5 @@ replacers:
     replace: ''
   - search: '/(?:and )?@bors(?:\[bot\])?,?/g'
     replace: ''
+  - search: '/(?:and )?@meili-bot,?/g'
+    replace: ''

.github/workflows/test.yml

@@ -24,12 +24,9 @@ jobs:
         run: yarn test
       - name: Build project
         run: yarn build
-      - name: Run ESM demo
-        run: yarn test:demo:esm
-      - name: Run Node.js demo
-        run: yarn test:demo:nodejs
-      - name: Run Browser demo
-        run: yarn test:demo:browser
+      - name: Run env tests
+        run: yarn test:env
+
 
   style:
     name: style-check
@@ -50,9 +47,5 @@ jobs:
       - uses: actions/checkout@v1
       - name: Install dependencies
         run: yarn install
-      - name: Run Vue build
-        run: yarn build:playground:vue
-      - name: Run React build
-        run: yarn build:playground:react
-      - name: Run Vanilla JS build
-        run: yarn build:playground:vanilla-js
+      - name: Run Playgrounds Builds
+        run: yarn test:playgrounds

.gitignore

@@ -105,3 +105,6 @@ dist
 
 # misc
 .DS_Store
+
+# parcel
+.parcel_cache/

CONTRIBUTING.md

@@ -8,6 +8,7 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume
 - [How to Contribute](#how-to-contribute)
 - [Development Workflow](#development-workflow)
 - [Git Guidelines](#git-guidelines)
+- [Release Process (for internal team only)](#release-process-for-internal-team-only)
 
 <!-- /MarkdownTOC -->
 
@@ -23,7 +24,7 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume
 2. Once done, [fork the instant-meilisearch repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) in your own GitHub account. Ask a maintainer if you want your issue to be checked before making a PR.
 3. [Create a new Git branch](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository).
 4. Review the [Development Workflow](#workflow) section that describes the steps to maintain the repository.
-5. Make your changes.
+5. Make the changes on your branch.
 6. [Submit the branch as a PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) pointing to the `master` branch of the main instant-meilisearch repository. A maintainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer.<br>
  We do not enforce a naming convention for the PRs, but **please use something descriptive of your changes**, having in mind that the title of your PR will be automatically added to the next [release changelog](https://github.com/meilisearch/instant-meilisearch/releases/).
 
@@ -68,40 +69,15 @@ Or the React playground:
 $ yarn playground:react
 ```
 
-Or the Vanilla JavaScript playground:
+Or the JavaScript playground:
 ```
-$ yarn playground:vanilla-js
+$ yarn playground:javascript
 ```
 
-### Release Process
-
-MeiliSearch tools follow the [Semantic Versioning Convention](https://semver.org/).
-
-#### Automated Changelogs
-
-For each PR merged on `master`, a GitHub Action is running and updates the next release description as a draft release in the [GitHub interface](https://github.com/meilisearch/instant-meilisearch/releases). If you don't have the right access to this repository, you will not be able to see the draft release until the release is published.
-
-The draft release description is therefore generated and corresponds to all the PRs titles since the previous release. This means each PR should only do one change and the title should be descriptive of this change.
-
-About this automation:
-- As the draft release description is generated on every push on `master`, don't change it manually until the final release publishment.
-- If you don't want a PR to appear in the release changelogs: add the label `skip-changelog`. We suggest removing PRs updating the README or the CI (except for big changes).
-- If the changes you are doing in the PR are breaking: add the label `breaking-change`. In the release tag, the minor will be increased instead of the patch. The major will never be changed until [MeiliSearch](https://github.com/meilisearch/MeiliSearch) is stable.
-- If you did any mistake, for example the PR is already closed but you forgot to add a label or you misnamed your PR, don't panic: change what you want in the closed PR and run the job again.
-
-*More information about the [Release Drafter](https://github.com/release-drafter/release-drafter), used to automate these steps.*
-
-#### How to Publish the Release
-
-Make a PR modifying the file [`package.json`](/package.json) with the right version.
-
-```javascript
-"version": "X.X.X"
+Or the HTML playground:
+```
+$ yarn playground:html
 ```
-
-Once the changes are merged on `master`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/instant-meilisearch/releases).
-
-A GitHub Action will be triggered and push the package to [npm](https://www.npmjs.com/package/@meilisearch/instant-meilisearch).
 
 ## Git Guidelines
 
@@ -123,11 +99,47 @@ We don't follow any other convention, but if you want to use one, we recommend [
 ### GitHub Pull Requests
 
 Some notes on GitHub PRs:
+
 - [Convert your PR as a draft](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request) if your changes are a work in progress: no one will review it until you pass your PR as ready for review.<br>
   The draft PR can be very useful if you want to show that you are working on something and make your work visible.
-- The branch related to the PR must be **up-to-date with `master`** before merging. You need to [rebase your branch](https://gist.github.com/curquiza/5f7ce615f85331f083cd467fc4e19398) if it is not.
+- The branch related to the PR must be **up-to-date with `master`** before merging. Fortunately, this project [integrates a bot](https://github.com/meilisearch/integration-guides/blob/master/guides/bors.md) to automatically enforce this requirement without the PR author having to do it manually..
 - All PRs must be reviewed and approved by at least one maintainer.
-- All PRs have to be **squashed and merged**.
 - The PR title should be accurate and descriptive of the changes. The title of the PR will be indeed automatically added to the next [release changelogs](https://github.com/meilisearch/instant-meilisearch/releases/).
 
+## Release Process (for internal team only)
+
+MeiliSearch tools follow the [Semantic Versioning Convention](https://semver.org/).
+
+### Automation to Rebase and Merge the PRs
+
+This project integrates a bot that helps us manage pull requests merging.<br>
+_[Read more about this](https://github.com/meilisearch/integration-guides/blob/master/guides/bors.md)._
+
+### Automated Changelogs
+
+This project integrates a tool to create automated changelogs.<br>
+_[Read more about this](https://github.com/meilisearch/integration-guides/blob/master/guides/release-drafter.md)._
+
+### How to Publish the Release
+
+Make a PR modifying the file [`package.json`](/package.json) with the right version.
+
+```javascript
+"version": "X.X.X"
+```
+
+Once the changes are merged on `master`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/instant-meilisearch/releases).
+
+GitHub Actions will be triggered and push the package to [npm](https://www.npmjs.com/package/@meilisearch/instant-meilisearch).
+
+Once the version is available on npm, please update the instant-meilisearch version used in the different Code-Sandboxes we provide:
+
+- [MeiliSearch + InstantSearch](https://codesandbox.io/s/ms-is-mese9)
+- [MeiliSearch + Vue InstantSearch](https://codesandbox.io/s/ms-vue-is-1d6bi)
+- [MeiliSearch + React InstantSearch](https://codesandbox.io/s/ms-react-is-sh9ud)
+
+If you don't have the access to do it, please request it internally.
+
+<hr>
+
 Thank you again for reading this through, we can not wait to begin to work with you if you made your way through this contributing guide ❤️

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 MeiliSearch
+Copyright (c) 2020-2021 MeiliSearch
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -7,25 +7,23 @@
 <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>
 
 <p align="center">
   <a href="https://www.npmjs.com/package/@meilisearch/instant-meilisearch"><img src="https://img.shields.io/npm/v/@meilisearch/instant-meilisearch.svg" alt="npm version"></a>
   <a href="https://github.com/meilisearch/instant-meilisearch/actions"><img src="https://github.com/meilisearch/instant-meilisearch/workflows/Tests/badge.svg?branch=master" alt="Tests"></a>
   <a href="https://github.com/meilisearch/instant-meilisearch/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://github.com/meilisearch/MeiliSearch/discussions" alt="Discussions"><img src="https://img.shields.io/badge/github-discussions-red" /></a>
   <a href="https://app.bors.tech/repositories/28908"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
 </p>
 
 <p align="center">⚡ How to integrate a front-end search bar in your website using MeiliSearch</p>
 
-**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, facets, and synonyms are provided out-of-the-box.
+**MeiliSearch** is an open-source search engine. [Discover what MeiliSearch is!](https://github.com/meilisearch/MeiliSearch)
 
 This library is a plugin to establish the communication between your [MeiliSearch](https://github.com/meilisearch/MeiliSearch) instance and the open-source [InstantSearch](https://github.com/algolia/instantsearch.js) tools (powered by Algolia) for your front-end application.<br>
 Instead of reinventing the wheel, we have opted to reuse the InstantSearch library for our own front-end tooling. We will contribute upstream any improvements that may result from our adoption of InstantSearch.
@@ -37,11 +35,25 @@ If you use React or Vue, you might want to check out these repositories:
 
 NB: If you don't have any MeiliSearch instance running and containing your data, you should take a look at this [getting started page](https://docs.meilisearch.com/guides/introduction/quick_start_guide.html).
 
+## Installation
+
+Use `npm` or `yarn` to install `instant-meilisearch`:
+
+```bash
+$ npm install @meilisearch/instant-meilisearch
+```
+
+```bash
+$ yarn add @meilisearch/instant-meilisearch
+```
+
 ## Usage
 
 ### Basic
 
 ```js
+import instantMeiliSearch from "@meilisearch/instant-meilisearch";
+
 const searchClient = instantMeiliSearch(
   "https://demos.meilisearch.com",
   "dc3fedaf922de8937fdea01f0a7d59557f1fd31832cb8440ce94231cfdde7f25"
@@ -51,6 +63,8 @@ const searchClient = instantMeiliSearch(
 ### Customization
 
 ```js
+import instantMeiliSearch from "@meilisearch/instant-meilisearch";
+
 const searchClient = instantMeiliSearch(
   "https://demos.meilisearch.com",
   "dc3fedaf922de8937fdea01f0a7d59557f1fd31832cb8440ce94231cfdde7f25",
@@ -143,7 +157,7 @@ search.start();
 
 ## Compatibility with MeiliSearch
 
-This package only guarantees the compatibility with the [version v0.16.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.16.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).
 
 ## Development Workflow and Contributing