Merge pull request #503 from rmsacks/apparmor-libstdc++

[torbrowser-launcher.git] / README.md

diff --git a/README.md b/README.md
index 9ca9f3aefd80e45fe368fdd0bfe61ccab54a5007..421fde14b86d51f4e72f9c82b5393e9061ca19e1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
 # Tor Browser Launcher
 
+_**Are you getting an error?** Sometimes updates in Tor Browser itself will break Tor Browser Launcher. There's a good chance that the problem you're experiencing has already been fixed in the [newest version](https://github.com/micahflee/torbrowser-launcher/releases). Try installing from Flatpak (instructions below), or [build from source](/BUILD.md)._
+
 Tor Browser Launcher is intended to make Tor Browser easier to install and use for GNU/Linux users. You install ```torbrowser-launcher``` from your distribution's package manager and it handles everything else:
 
 * Downloads and installs the most recent version of Tor Browser in your language and for your computer's architecture, or launches Tor Browser if it's already installed (Tor Browser will automatically update itself)
@@ -14,12 +16,38 @@ You might want to check out the [security design doc](/security_design.md).
 
 ![Tor Browser Launcher screenshot](/screenshot.png)
 
-# Installing in Ubuntu
+# Installing
+
+You can install `torbrowser-launcher` from your operating system's package manager, but it might be out-of-date and have issues working. If you want to make sure you always have the latest version, use one of the methods below to install:
+
+## Installing in any Linux distro using Flatpak
+
+Install Flatpak using these [instructions](https://flatpak.org/setup/).
+
+Then install `torbrowser-launcher` like this:
+
+```
+flatpak install flathub com.github.micahflee.torbrowser-launcher -y
+```
+
+Run `torbrowser-launcher` either by using the GUI desktop launcher, or by running:
+
+```
+flatpak run com.github.micahflee.torbrowser-launcher
+```
+
+## Installing from the PPA
 
-If you want to always have the latest version of the `torbrowser-launcher` package before your distribution gets it, you can use my PPA:
+If you use Ubuntu or one of its derivatives:
 
 ```sh
 sudo add-apt-repository ppa:micahflee/ppa
-sudo apt-get update
-sudo apt-get install torbrowser-launcher
+sudo apt update
+sudo apt install torbrowser-launcher
+```
+
+Run `torbrowser-launcher` either by using the GUI desktop launcher, or by running:
+
 ```
+torbrowser-launcher
+```
\ No newline at end of file