psi-jack/dotbot
1
0
Fork 0
mirror of synced 2024-11-16 13:35:35 -05:00
Code Issues Releases Wiki Activity

add plugins section documents

Browse source 
Signed-off-by: Andreas Schmidt <mail@schmidt-andreas.de>
This commit is contained in:
schmidtandreas 2018-12-08 15:09:15 +01:00 committed by GitHub
parent e07ed9374a
commit fea35ea42a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -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
----