From d16dd95d6541f40457e916d142b06cb49d4b5b2f Mon Sep 17 00:00:00 2001 From: Jokob-sk Date: Sun, 12 Feb 2023 17:45:49 +1100 Subject: [PATCH] Plugins 0.1 - Readme update --- front/plugins/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/front/plugins/README.md b/front/plugins/README.md index 09ef149f..ce86abfd 100755 --- a/front/plugins/README.md +++ b/front/plugins/README.md @@ -1,3 +1,7 @@ +# ⚠ Disclaimer + +Highly experimental feature. Follow the below very carefully and check example plugin(s). Plugin UI is not my priority right now, happy to approve PRs if you are interested in extending/improvintg the UI experience. + ## Overview PiAlert comes with a simple plugin system to feed events from third-party scripts into the UI and then send notifications if desired. @@ -8,7 +12,7 @@ If you wish to develop a plugin, please check the existing plugin structure. | File | Required | Description | |----------------------|----------------------|----------------------| - | `config.json` | yes | Contains the plugin configuration including the settings available to the user. | + | `config.json` | yes | Contains the plugin configuration (manifest) including the settings available to the user. | | `script.py` | yes | The Python script itself | | `last_result.log` | yes | The file used to interface between PiAlert and the plugin (script). | | `script.log` | no | Logging output (recommended) |