Add instructions for basic use of msync when needing to make updates

theforeman · Nov 2, 2020 · 7b788df · 7b788df
1 parent 8e29149
commit 7b788df
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -8,6 +8,17 @@ across all of the Foreman installer modules.
 A full description of ModuleSync can be found in [ModuleSync's
 README](https://github.com/puppetlabs/modulesync).
 
+## Applying Updates
+
+To initialize the modules for updates, use modulesync's update feature with noop:
+
+```
+bundle exec msync update --noop
+```
+
+This will clone all modules into `modules/` and apply any pending updates. Changes can then be inspected and Pull Request's
+opened to get the changes committed across the set of managed modules.
+
 ## Releasing
 
 ### Setup