boilerplate-plugin/README.md

27 lines
713 B
Markdown
Raw Normal View History

2014-04-21 23:21:06 +04:00
# Boilerplate plugin
It does nothing but can be used as a template for a real plugin.
2014-05-29 16:23:36 +04:00
## Installation
1. Download files of the plugin.
2. Create folder "`<Mibew root>`/plugins/Mibew/Mibew/Plugin/Boilerplate" (case does matter).
2014-05-29 16:23:36 +04:00
3. Put files of the plugins to the just created folder.
4. Add plugins configs to "plugins" structure in "`<Mibew root>`/configs/config.yml". If the "plugins" stucture looks like `plugins: []` it will become:
2014-11-27 15:11:48 +03:00
```yaml
plugins:
"Mibew:Boilerplate":
very_important_value: "$3.50"
```
2014-11-27 15:01:12 +03:00
5. Navigate to "`<Mibew Base URL>`/operator/plugin" page and enable the plugin.
2014-05-29 16:34:00 +04:00
## License
[Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)