summaryrefslogtreecommitdiff
path: root/Data/BuiltIn/Libraries/lua-addons/addons/update/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'Data/BuiltIn/Libraries/lua-addons/addons/update/readme.md')
-rw-r--r--Data/BuiltIn/Libraries/lua-addons/addons/update/readme.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/Data/BuiltIn/Libraries/lua-addons/addons/update/readme.md b/Data/BuiltIn/Libraries/lua-addons/addons/update/readme.md
new file mode 100644
index 0000000..3a1adb3
--- /dev/null
+++ b/Data/BuiltIn/Libraries/lua-addons/addons/update/readme.md
@@ -0,0 +1,39 @@
+# Update
+
+Once loaded can update all addons and plugins to the newest version using `//update`. This can also be done automatically by configuring the settings file or by typing `//update auto`.
+
+### Commands
+
+#### Update
+
+```
+update
+```
+
+Will send an update command.
+
+**Note:** This interferes with Spellcast XMLs using the custom `update` trigger command. To resolve that problem stop using Spellcast.
+
+#### Toggle automatic updates
+
+```
+update auto [on|off]
+```
+
+Sets automatic updating to on or off (toggles if no argument specified). Note that automatic updates will not check for updates while you're currently in combat.
+
+#### Set update interval
+
+```
+update interval <time>
+```
+
+Sets the automatic update interval to the provided time. Allows unit conversion, defaults to seconds. Example:
+
+```
+update interval 5min
+update interval 2h
+update interval 30
+```
+
+These will set the interval to 5 minutes, 2 hours and 30 seconds respectively.