Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
long2ice committed May 12, 2023
1 parent 7607a12 commit 3bf7040
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 3 deletions.
33 changes: 30 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,9 +139,11 @@ Enable debug mode, default is `false`, if you want to see more logs, you can set

### plugins (optional)

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

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.
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.

```python
class Plugin:
Expand All @@ -156,7 +158,8 @@ class Plugin:
return event
```

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.
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.

### progress

Expand Down Expand Up @@ -209,6 +212,30 @@ Sentry configuration.
- `dsn`: the sentry dsn.
- `environment`: the sentry environment, default is `production`.

## meilisync-admin (under development)

There is a web admin dashboard for meilisync, which is a paid feature, you can contact me by
email [[email protected]](mailto:[email protected]) if you are interested.

Check the demo at: https://demo.meilisync.com

- **email**: `[email protected]`
- **password**: `demo`

### Screenshot

![meilisync-admin](./images/meilisync-admin.png)

### Features

- Support multiple source and meilisearch instances.
- Support Sync task management.
- Admin management and access control.
- Action logs audit.
- i18n support.
- Feature request and technical support.
- More features coming soon.

## License

This project is licensed under the
Expand Down
Binary file added images/meilisync-admin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3bf7040

Please sign in to comment.