mirror of
https://github.com/Mibew/title-notification-plugin.git
synced 2025-01-22 09:30:33 +03:00
Update installation instructions
This commit is contained in:
parent
a0de85bf58
commit
3f26559dec
18
README.md
18
README.md
@ -6,18 +6,20 @@ It provides notification about new messages and new threads in window title.
|
||||
## Installation
|
||||
|
||||
1. Get the archive with the plugin sources. At the moment the only option is to build the plugin from sources.
|
||||
|
||||
2. Untar/unzip the plugin's archive.
|
||||
|
||||
3. Put files of the plugins to the `<Mibew root>/plugins` folder.
|
||||
4. Add plugins definition to "plugins" structure in "`<Mibew root>`/configs/config.yml".
|
||||
If the "plugins" stucture looks like `plugins: []` it will become:
|
||||
```yaml
|
||||
plugins:
|
||||
-
|
||||
name: "Mibew:TitleNotification"
|
||||
config: # Plugin's configurations are described below
|
||||
|
||||
4. (optional) Add plugins configs to "plugins" structure in "`<Mibew root>`/configs/config.yml". If the "plugins" stucture looks like `plugins: []` it will become:
|
||||
```yaml
|
||||
plugins:
|
||||
"Mibew:TitleNotification": # Plugin's configurations are described below
|
||||
new_thread: false
|
||||
new_message: "operator"
|
||||
```
|
||||
```
|
||||
|
||||
5. Navigate to "`<Mibew Base URL>`/operator/plugin" page and enable the plugin.
|
||||
|
||||
|
||||
## Plugin's configurations
|
||||
|
Loading…
Reference in New Issue
Block a user