Skip to content

Commit 0892a6d

Browse files
committed
docs: remove WIP mention and add a screenshot
1 parent febe68d commit 0892a6d

File tree

4 files changed

+14
-8
lines changed

4 files changed

+14
-8
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
11
# Meilisearch Plugin for NodeBB
22

3-
A work-in-progress search plugin integrating [Meilisearch](https://www.meilisearch.com/). It's not well tested yet, but should work.
3+
A search plugin integrating [Meilisearch](https://www.meilisearch.com/).
44

55
Make sure to disable `nodebb-plugin-dbsearch` when using this plugin.
66

77
## Installation
88

9-
1. Make sure you have an instance of [Meilisearch](https://www.meilisearch.com/)
9+
1. Make sure you have access to an instance of [Meilisearch](https://www.meilisearch.com/)
1010

11-
2. Install the plugin: `npm install nodebb-plugin-meilisearch`
11+
2. Install the plugin: `npm install nodebb-plugin-meilisearch` (or just use the ACP)
1212

13-
3. Set your URL and API Key in the ACP
13+
3. Set your URL and API Key in the ACP under `admin/plugins/meilisearch`
14+
15+
## Screenshots
16+
17+
#### ACP:
18+
19+
![Settings screenshot](settings-screenshot.png)

library.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ plugin.reindex = async function (force = false) {
238238
total: 0,
239239
},
240240
};
241-
winston.info(`[plugin/meilisearch] Reindexing posts and topics${force ? ' (forced)' : ''}`);
241+
winston.info(`[plugin/meilisearch] Indexing posts and topics${force ? ' (forced)' : ''}`);
242242
try {
243243
if (force) {
244244
await plugin.client.index('post').deleteAllDocuments();
@@ -305,10 +305,10 @@ plugin.reindex = async function (force = false) {
305305
current: null,
306306
},
307307
};
308-
winston.info('[plugin/meilisearch] Reindexing complete');
308+
winston.info('[plugin/meilisearch] Indexing complete');
309309
});
310310
} catch (err) {
311-
winston.error(`[plugin/meilisearch] Reindexing failed: ${err.message}`);
311+
winston.error(`[plugin/meilisearch] Indexing failed: ${err.message}`);
312312
plugin.indexing = {
313313
running: false,
314314
topic_progress: {

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "nodebb-plugin-meilisearch",
33
"version": "0.4.0",
4-
"description": "A WIP plugin for integrating MeiliSearch with NodeBB",
4+
"description": "A plugin for integrating MeiliSearch with NodeBB",
55
"main": "library.js",
66
"repository": {
77
"type": "git",

settings-screenshot.png

123 KB
Loading

0 commit comments

Comments
 (0)