docs(readme): add the description of event

This commit is contained in:
MasouShizuka
2025-06-14 10:03:44 +08:00
parent 568168c09e
commit 696214ca62

View File

@@ -10,10 +10,10 @@ https://github.com/MasouShizuka/projects.yazi/assets/44764707/79c3559a-7776-48cd
## Features ## Features
- Save/load projects - Save/load projects
- Load last project - Load last project
- Projects persistence - Projects persistence
- Merge a project or its current tab to other projects - Merge a project or its current tab to other projects
## Installation ## Installation
@@ -167,6 +167,12 @@ The last project is loaded by `load_last` command.
`quit_after_merge`: the merged project will be exited after merging. `quit_after_merge`: the merged project will be exited after merging.
### `event`
The corresponding event will be sent when the corresponding function is executed.
For specific usage, please refer to [#5](https://github.com/MasouShizuka/projects.yazi/issues/5) and [#12](https://github.com/MasouShizuka/projects.yazi/issues/12).
### `notify` ### `notify`
When enabled, notifications are displayed when actions are performed. When enabled, notifications are displayed when actions are performed.