Browse Source

more updates to readme

David Yurkiewicz 1 month ago
parent
commit
b2ef2c88df
1 changed files with 3 additions and 1 deletions
  1. 3 1
      README.md

+ 3 - 1
README.md

@@ -87,7 +87,7 @@ List here the commands you want to run on the remote hosts:
87 87
 ```
88 88
 
89 89
 #### files
90
-List here the files you want to copy to the remote hosts. The action key is important here. miniConfig can add or remove files:
90
+List here the files you want to copy to the remote hosts. The action key is mandatory, select either `add` or `remmove` depending on the desired outcome. `service_notify` is an optional key that can restart a specified service after the file has been add or remove:
91 91
 ```
92 92
   "files": [{
93 93
     "name": "index.php",
@@ -101,6 +101,8 @@ List here the files you want to copy to the remote hosts. The action key is impo
101 101
 ```
102 102
 Note: The files listed here must be included under `roles/role-name/files` directory. File ownership/group and mode are optional.
103 103
 
104
+When using the `service_notify` key make sure to include the actual service name. 
105
+
104 106
 
105 107
 
106 108
 ## Logging