Skip to content

Commit f2c8e7d

Browse files
authored
docs: basic README
1 parent 996b1c7 commit f2c8e7d

File tree

1 file changed

+5
-9
lines changed

1 file changed

+5
-9
lines changed

README.md

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

3-
A starter kit for quickly creating NodeBB plugins. Comes with a pre-setup LESS file, server side JS script with an `action:app.load` hook, and a client-side script. Most plugins need at least one of the above, so this ought to save you some time. For a full list of hooks have a look at our [wiki page](https://github.com/NodeBB/NodeBB/wiki/Hooks), and for more information about creating plugins please visit our [documentation portal](https://docs.nodebb.org/).
3+
A work-in-progress search plugin integrating [Meilisearch](https://www.meilisearch.com/). It's not well tested yet, but should work.
44

5-
Fork this or copy it, and using your favourite text editor find and replace all instances of `nodebb-plugin-meilisearch` with `nodebb-plugin-your-plugins-name`. Change the author's name in the LICENSE and package.json files.
6-
7-
## Hello World
8-
9-
Really simple, just edit `static/lib/main.js` and paste in `console.log('hello world');`, and that's it!
5+
Make sure to disable `nodebb-plugin-dbsearch` when using this plugin.
106

117
## Installation
128

13-
npm install nodebb-plugin-meilisearch
9+
1. Make sure you have an instance of [Meilisearch](https://www.meilisearch.com/)
1410

15-
## Screenshots
11+
2. Install the plugin: `npm install nodebb-plugin-meilisearch`
1612

17-
Don't forget to add screenshots!
13+
3. Set your URL and API Key in the ACP

0 commit comments

Comments
 (0)