Skip to content

Commit 0012fa1

Browse files
bors[bot]bidoubiwa
andauthored
Merge #235
235: Add installation to Readme r=bidoubiwa a=bidoubiwa Co-authored-by: Charlotte Vermandel <[email protected]> Co-authored-by: cvermand <[email protected]>
2 parents 8b46d8d + 6256393 commit 0012fa1

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,25 @@ If you use React or Vue, you might want to check out these repositories:
3535

3636
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).
3737

38+
## Installation
39+
40+
Use `npm` or `yarn` to install `instant-meilisearch`:
41+
42+
```bash
43+
$ npm install @meilisearch/instant-meilisearch
44+
```
45+
46+
```bash
47+
$ yarn add @meilisearch/instant-meilisearch
48+
```
49+
3850
## Usage
3951

4052
### Basic
4153

4254
```js
55+
import instantMeiliSearch from "@meilisearch/instant-meilisearch";
56+
4357
const searchClient = instantMeiliSearch(
4458
"https://demos.meilisearch.com",
4559
"dc3fedaf922de8937fdea01f0a7d59557f1fd31832cb8440ce94231cfdde7f25"
@@ -49,6 +63,8 @@ const searchClient = instantMeiliSearch(
4963
### Customization
5064

5165
```js
66+
import instantMeiliSearch from "@meilisearch/instant-meilisearch";
67+
5268
const searchClient = instantMeiliSearch(
5369
"https://demos.meilisearch.com",
5470
"dc3fedaf922de8937fdea01f0a7d59557f1fd31832cb8440ce94231cfdde7f25",

0 commit comments

Comments
 (0)