diff --git a/README.md b/README.md index 8bc33e5..32365d3 100644 --- a/README.md +++ b/README.md @@ -8,17 +8,19 @@ Emoticons like :-) and ;D are also supported. ## 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 `/plugins` folder. -4. Add plugins definition to "plugins" structure in "``/configs/config.yml". -If the "plugins" stucture looks like `plugins: []` it will become: -```yaml -plugins: - - - name: "Mibew:Emoji" - config: # Plugin's configurations are described below + +4. (optional) Add plugins configs to "plugins" structure in "``/configs/config.yml". If the "plugins" stucture looks like `plugins: []` it will become: + ```yaml + plugins: + "Mibew:Emoji": # Plugin's configurations are described below ignore_emoticons: false -``` + ``` + +5. Navigate to "``/operator/plugin" page and enable the plugin. ## Plugin's configurations