From 8a27e25192a3ad11f70dc2e9ab021ac4620ef947 Mon Sep 17 00:00:00 2001
From: Dragory <2606411+Dragory@users.noreply.github.com>
Date: Tue, 27 Oct 2020 19:26:11 +0200
Subject: [PATCH] Add docs on how to update the bot

---
 README.md        |  1 +
 docs/updating.md | 17 +++++++++++++++++
 2 files changed, 18 insertions(+)
 create mode 100644 docs/updating.md

diff --git a/README.md b/README.md
index 67d1504..6de8952 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,7 @@ Always take a backup of your `db/data.sqlite` file before updating the bot.
 
 ## Getting started
 * **[🛠️ Setting up the bot](docs/setup.md)**
+* **[✨ Updating the bot](docs/updating.md)**
 * **[🙋 Frequently Asked Questions](docs/faq.md)**
 * [📝 Configuration](docs/configuration.md)
 * [🤖 Commands](docs/commands.md)
diff --git a/docs/updating.md b/docs/updating.md
new file mode 100644
index 0000000..d3fbcd8
--- /dev/null
+++ b/docs/updating.md
@@ -0,0 +1,17 @@
+# ✨ Updating the bot
+
+**Before updating the bot, always take a backup of your `db/data.sqlite` file.**
+
+To update the bot, follow these steps:
+1. Shut down the bot
+2. Take a backup of your `db/data.sqlite` file
+    * If you're using a different supported database, take database backups from there
+3. Download the latest version of the bot from https://github.com/Dragory/modmailbot/releases/latest
+4. Extract the new version's files over the old files
+5. Read the [CHANGELOG](https://github.com/Dragory/modmailbot/blob/master/CHANGELOG.md) to see if there are any config changes you have to make
+    * Especially note changes to supported Node.js versions!
+6. Start the bot:
+    * If you're using `start.bat` to run the bot, just run it again
+    * If you're running the bot via command line, first run `npm ci` and then start the bot again
+
+👉 If you run into any issues, **[join the support server for help!](https://discord.gg/vRuhG9R)**