summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorLinus Färnstrand <linus@mullvad.net>2019-10-25 15:54:10 +0200
committerLinus Färnstrand <linus@mullvad.net>2019-10-28 10:47:29 +0100
commitc3e7da9347ef29864ed6060d44b22cd4a471d930 (patch)
tree447c7b410cb7551c704fefa55af28c1d9b8322ce
parent2743b9c1aff4cf9222db46e53800b74ae9b315fa (diff)
downloadmullvadvpn-c3e7da9347ef29864ed6060d44b22cd4a471d930.tar.xz
mullvadvpn-c3e7da9347ef29864ed6060d44b22cd4a471d930.zip
Add feature table to README
-rw-r--r--README.md16
1 files changed, 14 insertions, 2 deletions
diff --git a/README.md b/README.md
index 9d79961df6..e5086d5a9e 100644
--- a/README.md
+++ b/README.md
@@ -4,14 +4,26 @@ The system service/daemon, GUI and CLI for the Mullvad VPN app.
## Releases
-There are built and signed releases for macOS, Windows and Linux available on
+There are built and signed releases for macOS, Windows, Linux and Android available on
[our website](https://mullvad.net/download/) and on
[Github](https://github.com/mullvad/mullvadvpn-app/releases/).
-Support for Android and iOS is in the making.
+Support for iOS is in the making.
You can find our code signing keys as well as instructions for how to cryptographically verify
your download on [Mullvad's Open Source page].
+## Features
+
+Here is a table containing the features of the app accross platforms. This reflects the current
+state of latest master, not necessarily any existing release.
+
+| | Windows | Linux | macOS | Android |
+|-------------------------------|:-------:|:-----:|:-----:|:-------:|
+| OpenVPN | ✓ | ✓ | ✓ | |
+| WireGuard | | ✓ | ✓ | ✓ |
+| OpenVPN over Shadowsocks | ✓ | ✓ | ✓ | |
+| Optional local network access | ✓ | ✓ | ✓ | |
+
## Checking out the code
This repository contains submodules needed for building the app. However, some of those submodules