diff --git a/plugins/README.md b/plugins/README.md index 093e510..be512ad 100644 --- a/plugins/README.md +++ b/plugins/README.md @@ -16,6 +16,16 @@ This `.run()` routine is called every time an alarm comes in Here are the information from BOSWatch available. See section `5. Process the data from BOSWatch` +#### 1.4 Requirements +Add all required (which need to be installed separately) python packages to a requirements.txt in the plugin directory so that the user can simply install all requirements for this plugin. + +For examples look at [the Telegram plugin](Telegram/requirements.txt) + +##### 1.4.1 Requirement installation +To install the packages from the requirements.txt run +`pip install -r /path/to/plugin/directory/requirements.txt` +Or because for the current version (2.5) Python2 is required +`pip2 install -r /path/to/plungin/directory/requirements.txt` will work for sure ## 2. Use Global Logging #### 2.1 Init and Use