diff --git a/README.md b/README.md index 250aee5..5613b01 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ Use the `/plugins install` command, e.g. /plugins install ~/projects-git/profanity-plugins/say.py ``` -See the `/help plugins` command for further plugin management commands. +See the `/help plugins` command for further plugin management options. More help on plugins -------------------- @@ -89,6 +89,23 @@ command=cyan result=green ``` +Plugin settings +--------------- + +The plugins API also includes functions to read and write settings. The settings are stored in: + +``` +~/.local/share/profanity/plugin_settings +``` + +For example ([say.py](https://github.com/boothj5/profanity-plugins/blob/master/say.py) plugin): + +``` +[say] +args=-v english -s 120 +enabled=off +``` + Example plugin code -------------------