From fea35ea42a46140bac25c6b4a52f838a264c1b8d Mon Sep 17 00:00:00 2001 From: schmidtandreas <37267147+schmidtandreas@users.noreply.github.com> Date: Sat, 8 Dec 2018 15:09:15 +0100 Subject: [PATCH] add plugins section documents Signed-off-by: Andreas Schmidt --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 2416d3a..d867238 100644 --- a/README.md +++ b/README.md @@ -368,6 +368,27 @@ Plugins are loaded using the `--plugin` and `--plugin-dir` options, using either absolute paths or paths relative to the base directory. It is recommended that these options are added directly to the `install` script. +Additional to using `--plugin` and `--plugin-dir` options for `install` script, +you can specify `plugins` section in your configuration file. The plugins get +added in order to position in configation file. It is recommended to add `plugins` +section to the top of the configuation file. + +#### Format + +Plugins are specified as a list of plugins or plugin directories. + +For plugins just specify absolute or relative to the base directory path to +plugin python module. For plugin directory use `dir` attribute. + +#### Example + +```yaml +plugins: + - dir:plugins/dotbot-sync + - plugins/asdf/asdf.py + +``` + Wiki ----