From 84f3d5071ec4d8a645b0538b3fb78509e1b3fca3 Mon Sep 17 00:00:00 2001
From: Newbyte <newbie13xd@gmail.com>
Date: Mon, 24 Jan 2022 15:24:29 +0100
Subject: [PATCH] docs/INSTALL.md: Update Flatpak instructions

Moment should be on Flathub soon enough, so let's tell users to get
it from there.
---
 docs/INSTALL.md | 52 ++++++++++++++++++++++++++++++++-----------------
 1 file changed, 34 insertions(+), 18 deletions(-)

diff --git a/docs/INSTALL.md b/docs/INSTALL.md
index e7ce42e2..d1eecf6d 100644
--- a/docs/INSTALL.md
+++ b/docs/INSTALL.md
@@ -39,38 +39,54 @@ see [manual installation](#manual-installation).
 Packages other than the Flatpak are not maintained by the Mirage 
 authors, and thus might be outdated.
 
-#### Flatpak (Leftover instructions from Mirage; not supported for Moment)
+#### Flatpak
 
 Mirage is also available as a Flatpak.
 
-1. Download the Mirage Flatpak from the
-[release page](https://github.com/mirukana/mirage/releases).
+1. Download the Mirage Flatpak from
+[Flathub](https://flathub.org/apps/details/xyz.mx_moment.moment). Alternatively,
+you can issue the following commands in a terminal:
+
+```sh
+flatpak remote-add --if-not-exists \
+    flathub https://flathub.org/repo/flathub.flatpakrepo
+
+flatpak install flathub xyz.mx_moment.moment
+
+flatpak run xyz.mx_moment.moment
+```
 
 2. If your operating system doesn't already have built-in support for Flatpaks,
 follow [these instructions](https://flatpak.org/setup/) to install Flatpak
 support on your system.
 
-3. To actually install and run Mirage, it should be enough to double-click the 
-downloaded `.flatpak` file, which will open your software manager.
-Alternatively, you can issue the following commands in a terminal:
+##### Configuration migration
 
-```sh
-flatpak remote-add --user --if-not-exists \
-    flathub https://flathub.org/repo/flathub.flatpakrepo
+Note that automatic migration of data from Mirage is not supported when using
+Flatpak. If you would like to manually migrate your logins, encryption keys,
+configuration and themes from Mirage, you can do it like so:
 
-flatpak install --user flathub org.kde.Platform//5.14
-flatpak install --user /path/to/downloaded/mirage-*.flatpak
+###### Migration from Mirage's Flatpak
 
-flatpak run io.github.mirukana.mirage
-```
+Issue the following commands:
 
-If downloading the dependencies fail due to e.g. a connection error,
-run `flatpak repair` before retrying.
+    $ mkdir -p ~/.var/app/xyz.mx_moment.moment/{config,data}
+    $ cd ~/.var/app
+    $ cp -r io.github.mirukana.mirage/config/mirage/* xyz.mx_moment.moment/config/moment
+    $ cp -r io.github.mirukana.mirage/data/mirage/* xyz.mx_moment.moment/data/moment
 
-If your architecture is not listed on the release page, clone the repository
-and see [packaging/flatpak/README.md](packaging/flatpak/README.md) to build the
-package on your machine.
+###### Migration from a distribution package
 
+Issue the following commands:
+
+    $ mkdir -p ~/.var/app/xyz.mx_moment.moment/{config,data}
+    $ cd ~/.var/app
+
+If you are on Debian, replace mirage with mirage-matrix in the following
+commands:
+
+    $ cp -r ~/.config/mirage/* xyz.mx_moment.moment/config/moment
+    $ cp -r ~/.local/share/mirage/* xyz.mx_moment.moment/data/moment
 
 ## Manual Installation