Skip to content

Commit 3bf7040

Browse files
committed
docs: update README
1 parent 7607a12 commit 3bf7040

File tree

2 files changed

+30
-3
lines changed

2 files changed

+30
-3
lines changed

README.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,9 +139,11 @@ Enable debug mode, default is `false`, if you want to see more logs, you can set
139139

140140
### plugins (optional)
141141

142-
The plugins are used to customize the data before or after insert to Meilisearch and the plugins is a list of python modules.
142+
The plugins are used to customize the data before or after insert to Meilisearch and the plugins is a list of python
143+
modules.
143144

144-
Which is a python class with `pre_event` and `post_event` methods, the `pre_event` method is called before insert to Meilisearch, the `post_event` method is called after insert to Meilisearch.
145+
Which is a python class with `pre_event` and `post_event` methods, the `pre_event` method is called before insert to
146+
Meilisearch, the `post_event` method is called after insert to Meilisearch.
145147

146148
```python
147149
class Plugin:
@@ -156,7 +158,8 @@ class Plugin:
156158
return event
157159
```
158160

159-
The `is_global` is used to indicate whether the plugin instance is global, if set to `True`, the plugin instance will be created only once, otherwise, the plugin instance will be created for each event.
161+
The `is_global` is used to indicate whether the plugin instance is global, if set to `True`, the plugin instance will be
162+
created only once, otherwise, the plugin instance will be created for each event.
160163

161164
### progress
162165

@@ -209,6 +212,30 @@ Sentry configuration.
209212
- `dsn`: the sentry dsn.
210213
- `environment`: the sentry environment, default is `production`.
211214

215+
## meilisync-admin (under development)
216+
217+
There is a web admin dashboard for meilisync, which is a paid feature, you can contact me by
218+
email [[email protected]](mailto:[email protected]) if you are interested.
219+
220+
Check the demo at: https://demo.meilisync.com
221+
222+
- **email**: `[email protected]`
223+
- **password**: `demo`
224+
225+
### Screenshot
226+
227+
![meilisync-admin](./images/meilisync-admin.png)
228+
229+
### Features
230+
231+
- Support multiple source and meilisearch instances.
232+
- Support Sync task management.
233+
- Admin management and access control.
234+
- Action logs audit.
235+
- i18n support.
236+
- Feature request and technical support.
237+
- More features coming soon.
238+
212239
## License
213240

214241
This project is licensed under the

images/meilisync-admin.png

270 KB
Loading

0 commit comments

Comments
 (0)