Merge pull request #584 from kpcyrd/github-actions

[torbrowser-launcher.git] / README.md

diff --git a/README.md b/README.md
index d3e67a256ab461db289504112447d0c4935d0c7c..b293a04ad3ad4ea9191c219e35efa94069239920 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,13 +1,14 @@
 # Tor Browser Launcher
 
-Tor Browser Launcher is intended to make the 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:
+_**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)._
 
-* Downloads the most recent version of Tor Browser in your language and for your computer's architecture (Tor Browser will automatically update itself)
-* Certificate pins to https://www.torproject.org, so it doesn't rely on certificate authorities
-* Verifies Tor Browser's [OpenPGP signature](https://www.torproject.org/docs/verifying-signatures.html.en) for you, to ensure the version you downloaded is not tampered with
+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)
+* Verifies Tor Browser's [signature](https://www.torproject.org/docs/verifying-signatures.html.en) for you, to ensure the version you downloaded was cryptographically signed by Tor developers and was not tampered with
 * Adds "Tor Browser" and "Tor Browser Launcher Settings" application launcher to your desktop environment's menu
 * Includes AppArmor profiles to make a Tor Browser compromise not as bad
-* Optionally playing a modem sound when you open Tor Browser (because Tor is so slow)
+* Optionally plays a modem sound when you open Tor Browser (because Tor is so slow)
 
 Tor Browser Launcher is included in Ubuntu, Debian, and Fedora. To install it in any other distribution, see the [build instructions](/BUILD.md).
 
@@ -15,13 +16,22 @@ 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 Flatpak:
+
+## Installing in any Linux distro using Flatpak
+
+Install Flatpak using these [instructions](https://flatpak.org/setup/).
 
-If you want to always have the latest version of the `torbrowser-launcher` package before your distribution gets it, you can use my PPA:
+Then install `torbrowser-launcher` like this:
 
-```sh
-sudo add-apt-repository ppa:micahflee/ppa
-sudo apt-get update
-sudo apt-get install torbrowser-launcher
 ```
+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
+```