Mibew/boilerplate-plugin
1
0
Fork 0
mirror of https://github.com/Mibew/boilerplate-plugin.git synced 2025-02-05 16:54:41 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update installation instructions

Browse Source
This commit is contained in:
Dmitriy Simushev 2014-11-27 12:01:12 +00:00
parent 144773fbe5
commit 163324ce9b
2 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Plugin.php
View File

@ -32,8 +32,8 @@
* - Foo12:Bar * - Foo12:Bar
* - Acme:TheBestPlugin * - Acme:TheBestPlugin
* *
* To turn the plugin on add its definition to the following to "plugins" * To configure the plugin add its configs to the "plugins" structure in
* structure in <mibew root>/configs/config.yml if the "plugins" structure looks * "<mibew root>/configs/config.yml" file. If the "plugins" structure looks
* like: * like:
* <code> * <code>
* plugins: [] * plugins: []
@ -41,11 +41,12 @@
* it will become: * it will become:
* <code> * <code>
* plugins: * plugins:
* - * "Mibew:Boilerplate":
* name: "Mibew:Boilerplate" * very_important_value: "$3.50"
* config:
* very_important_value: "$3.50"
* </code> * </code>
*
* To turn the plugin on navigate to "<Mibew Base URL>/operator/plugin" page and
* enable the plugin.
*/ */
namespace Mibew\Mibew\Plugin\Boilerplate; namespace Mibew\Mibew\Plugin\Boilerplate;

10
README.md
View File

@ -7,15 +7,15 @@ It does nothing but can be used as a template for a real plugin.
1. Download files of the plugin. 1. Download files of the plugin.
2. Create folder "```<Mibew root>```/plugins/Mibew/Mibew/Plugin/Boilerplate" (case does matter). 2. Create folder "```<Mibew root>```/plugins/Mibew/Mibew/Plugin/Boilerplate" (case does matter).
3. Put files of the plugins to the just created folder. 3. Put files of the plugins to the just created folder.
4. Add plugins defenition to "plugins" structure in "```<Mibew root>```/configs/config.yml". 4. Add plugins configs to "plugins" structure in "```<Mibew root>```/configs/config.yml".
If the "plugins" stucture looks like ```plugins: []``` it will become: If the "plugins" stucture looks like ```plugins: []``` it will become:
```yaml ```yaml
plugins: plugins:
- "Mibew:Boilerplate":
name: "Mibew:Boilerplate" very_important_value: "$3.50"
config:
very_important_value: "$3.50"
``` ```
5. Navigate to "`<Mibew Base URL>`/operator/plugin" page and enable the plugin.
## License ## License