Skip to content

Commit 3d8aa2a

Browse files
committed
Rollback readme to previous
1 parent d6f860f commit 3d8aa2a

File tree

1 file changed

+16
-53
lines changed

1 file changed

+16
-53
lines changed

README.md

Lines changed: 16 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,13 @@ MeiliSearch is an open-source search engine. [Discover what MeiliSearch is!](ht
1313

1414
[Strapi](https://strapi.io/) is a backend CMS that makes creating and managing content easy.
1515

16+
## Usage during WIP
1617

17-
## ⏳ Installation
18+
Until this package is released on `npm`, you can use it the following way:
1819

19-
To use this project you will need to clone it _(until this package is added to npm)_:
20+
### ⏳ Installation
21+
22+
To use this project you will need to clone it:
2023

2124
```
2225
git clone [email protected]:meilisearch/strapi-plugin-meilisearch.git
@@ -32,67 +35,27 @@ yarn install
3235
npm install
3336
```
3437

35-
## Setup
36-
37-
To use MeiliSearch and Strapi there are two requirements:
38-
39-
### 🏃‍♀️ Run MeiliSearch
40-
41-
There are many easy ways to [download and run a MeiliSearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).
38+
### Using playground
4239

43-
For example, if you use Docker:
40+
Instead of adding the plugin to an existing project, you can try it out using the playground.
4441

4542
```bash
46-
docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
47-
docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey
43+
# with yarn
44+
yarn develop
4845
```
4946

50-
51-
### 🏃‍♂️ Run Strapi
52-
53-
If you don't have a running Strapi project yet, you can either launch the [playground present in this project](#playground) or [create a Strapi Project](#create-strapi-project).
54-
55-
## Quick Start
56-
57-
Now that you have installed the plugin, a running meiliSearch instance and, a running Strapi app, lets go on your admin panel.
58-
59-
On the left-navbar MeiliSearch appears under the `PLUGINS` category.
60-
61-
![](/assets/left_navbar.png)
62-
63-
Clicking on the plugin will bring you to the MeiliSearch dashboard.
64-
65-
### Add Credentials
66-
67-
First, add your MeiliSearch credentials on the upper box of the MeiliSearch plugin page. For example, using the above credentials it looks like this:
68-
69-
![](/assets/credentials.png)
70-
71-
Once completed, click on the `add` button.
72-
73-
74-
### Add your collections to MeiliSearch
75-
76-
If you don't have any collection yet in your Strapi Plugin, please follow [Strapi quickstart](https://strapi.io/documentation/developer-docs/latest/getting-started/quick-start.html). If you used the playground, two collections are present `restaurant` and `category`.
77-
78-
![](/assets/collections.png)
79-
80-
By clicking on the left checkbox, the collection will automatically indexed in MeiliSearch. For example, if you click on the `restaurant` checkbox, all your restaurants are now available in MeiliSearch.
81-
82-
### Run Playground
83-
84-
Instead of adding the plugin to an existing project, you can try it out using the playground in this project.
85-
47+
Or if you want to use `npm`, by going inside the directory:
8648
```bash
87-
# Root of repository
88-
yarn playground:dev
49+
# with npm
50+
cd playground
51+
npm install
52+
npm run develop
8953
```
9054

91-
This command will install required dependencies and launch the app in development mode. You should be able to reach it on the [port 8000 of your localhost](http://localhost:8000/admin/).
55+
Install Strapi with this **Quickstart** command to create a Strapi project instantly:
9256

93-
### Create Strapi project
9457

95-
Install Strapi with this **Quickstart** command to create a Strapi project instantly:
58+
#### Create strapi project
9659

9760
- Use **yarn** to install the Strapi project (recommended). [Install yarn with these docs](https://yarnpkg.com/lang/en/docs/install/).)
9861

0 commit comments

Comments
 (0)