diff --git a/README.md b/README.md index d51341b..dbd6fc7 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,9 @@ Version 2 implementation works roughly as follows: * if changes are detected, it runs install script (if present). ### Files -* `conf-sync.sh` +* `conf-sync.sh` is the main script, which updates the files. +* `variables.conf.templates` contains examples variables definitions, and should be copied locally to `variables.conf` + (with any required modifications). +* `systemd-templates/` contains Systemd units templates for running the script unattended. #### Installation -* `install.sh` +* `install.sh` script copies Systemd templates to their destination, and enables conf-sync timer.