Allow url_list

[torbrowser-launcher.git] / README.md

diff --git a/README.md b/README.md
index 5cf3548dd4b071d76a4cb4e632b1bc7d6c917d2a..b293a04ad3ad4ea9191c219e35efa94069239920 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,25 +1,37 @@
 # Tor Browser Launcher
 
-Tor Browser Launcher is intended to make the Tor Browser Bundle (TBB) easier to maintain and use for GNU/Linux users. You install ```torbrowser-launcher``` from your distribution's package manager and it handles everything else, including:
+_**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)._
 
-* Downloading the most recent version of TBB for you, in your language and for your architecture
-* Automatically updating (while preserving your bookmarks and preferences)
-* Verifying the TBB's [GnuPG signature](http://www.gnupg.org/gph/en/manual/x135.html)
+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
-* Adding a "Tor Browser" application launcher to your desktop environment's menu, and letting you set Tor Browser as your default browser
-* 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 14.10+, Debian 8+, and Fedora 20+. To install it in any other distribution, see the [build instructions](/BUILD.md).
+Tor Browser Launcher is included in Ubuntu, Debian, and Fedora. To install it in any other distribution, see the [build instructions](/BUILD.md).
 
 You might want to check out the [security design doc](/security_design.md).
 
 ![Tor Browser Launcher screenshot](/screenshot.png)
 
-## Installing in Ubuntu 14.04 and earlier
+# 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/).
+
+Then install `torbrowser-launcher` like this:
 
-I've created a PPA where I'm maintaining torbrowser-launcher binaries. You can install in an Ubuntu-based distribution like this:
+```
+flatpak install flathub com.github.micahflee.torbrowser-launcher -y
+```
 
-    sudo add-apt-repository ppa:micahflee/ppa
-    sudo apt-get update
-    sudo apt-get install torbrowser-launcher
+Run `torbrowser-launcher` either by using the GUI desktop launcher, or by running:
 
+```
+flatpak run com.github.micahflee.torbrowser-launcher
+```