diff --git a/README.md b/README.md index 5c19770..f337813 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,22 @@ WG Tunnel +
+ + An alternative Android client app for [WireGuard®](https://www.wireguard.com/) +and [AmneziaWG](https://docs.amnezia.org/documentation/amnezia-wg/) +
+
+ Report a Bug + · + Request a Feature + · + Ask a Question + +
+ +
+
[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/rbRRNh6H7V) @@ -11,72 +27,85 @@ WG Tunnel
- [![Google Play](https://img.shields.io/badge/Google_Play-414141?style=for-the-badge&logo=google-play&logoColor=white)](https://play.google.com/store/apps/details?id=com.zaneschepke.wireguardautotunnel) [![F-Droid](https://img.shields.io/static/v1?style=for-the-badge&message=F-Droid&color=1976D2&logo=F-Droid&logoColor=FFFFFF&label=)](https://f-droid.org/packages/com.zaneschepke.wireguardautotunnel/) +[![Personal](https://img.shields.io/static/v1?style=for-the-badge&message=Personal&color=1976D2&logo=F-Droid&logoColor=FFFFFF&label=)](https://github.com/zaneschepke/fdroid)
+
+Table of Contents -
+- [About](#about) +- [Acknowledgements](#acknowledgements) +- [Screenshots](#screenshots) +- [Features](#features) +- [Building](#building) +- [Translation](#translation) +- [Contributing](#contributing) -This is an alternative Android Application for [WireGuard](https://www.wireguard.com/) -and [AmneziaWG](https://docs.amnezia.org/documentation/amnezia-wg/) with added -features. Built using the [wireguard-android](https://github.com/WireGuard/wireguard-android) -library and [Jetpack Compose](https://developer.android.com/jetpack/compose), this application was -inspired by the official [WireGuard Android](https://github.com/WireGuard/wireguard-android) app. +
+ +
+ +## About +Inspired by the official [wireguard-android](https://github.com/WireGuard/wireguard-android) app, WG Tunnel was created to address features and support missing from the official app. This app combines support for both [WireGuard®](https://www.wireguard.com/) +and [AmneziaWG](https://docs.amnezia.org/documentation/amnezia-wg/), with its primary feature of auto-tunneling (on-demand tunneling).
-
+
+ +## Acknowledgements + +Thank you to the following: + +- All of the users that have helped contribute to the project with ideas, translations, feedback, bug reports, testing, and donations. +- [WireGuard®](https://www.wireguard.com/) - © Jason A. Donenfeld (https://github.com/WireGuard/wireguard-android) + +- [AmneziaWG](https://docs.amnezia.org/documentation/amnezia-wg/) - Amnezia Team (https://github.com/amnezia-vpn/amneziawg-android) ## Screenshots -

- - - - -

+
+
+ + + + +
-
- -## Inspiration - -The original inspiration for this app came from the inconvenience of having to manually turn VPN off -and on while on different networks. This app was created to offer a free solution to this problem. +
## Features -* Add tunnels via .conf file, zip, manual entry, or QR code -* Auto connect to tunnels based on Wi-Fi SSID, ethernet, or mobile data +* Add tunnels via .conf file, zip, manual entry, clipboard, or QR code +* Auto-tunnel based on Wi-Fi SSID, ethernet, or mobile data * Split tunneling by application with search -* WireGuard support for kernel and userspace modes +* Support for kernel and userspace modes * Amnezia support for userspace mode for DPI/censorship protection * Pre/Post Up/Down scripts support for all modes on a rooted device * Always-On VPN support -* Export Amnezia and WireGuard tunnels to zip +* Export tunnels to zip * Quick tile support for tunnel toggling, auto-tunneling -* Static shortcuts support for tunnel toggling, auto-tunneling +* Shortcuts support for tunnel toggling, auto-tunneling * Intent automation support for all tunnels +* In app VPN kill switch with LAN bypass * Automatic auto-tunneling service and/or tunnel restart after reboot or app update * Battery preservation measures -* Restart tunnel on ping failure (beta) +* Restart tunnel on ping failure -## Fdroid +## Building -Want updates faster? +```sh +git clone https://github.com/zaneschepke/wgtunnel +cd wgtunnel +``` -Check out my personal [fdroid repository](https://github.com/zaneschepke/fdroid) to get updates the -moment they are released. - -## Docs - -Information about features, behaviors, and answers to common questions can be found in the -app [documentation](https://zaneschepke.com/wgtunnel-docs/overview.html). - -The repository for these docs can be found [here](https://github.com/zaneschepke/wgtunnel-docs). +```sh +./gradlew assembleDebug +``` ## Translation @@ -86,19 +115,6 @@ Help translate WG Tunnel into your language at [Hosted Weblate](https://hosted.weblate.org/engage/wg-tunnel/).\ [![Translation status](https://hosted.weblate.org/widgets/wg-tunnel/-/multi-auto.svg)](https://hosted.weblate.org/engage/wg-tunnel/) -## Building - -``` -$ git clone https://github.com/zaneschepke/wgtunnel -$ cd wgtunnel -``` - -And then build the app: - -``` -$ ./gradlew assembleDebug -``` - ## Contributing Any contributions in the form of feedback, issues, code, or translations are welcome and much diff --git a/fastlane/metadata/android/en-US/images/phoneScreenshots/auto_screen.png b/fastlane/metadata/android/en-US/images/phoneScreenshots/auto_screen.png new file mode 100644 index 0000000..1f91e0e Binary files /dev/null and b/fastlane/metadata/android/en-US/images/phoneScreenshots/auto_screen.png differ diff --git a/fastlane/metadata/android/en-US/images/phoneScreenshots/config_screen.png b/fastlane/metadata/android/en-US/images/phoneScreenshots/config_screen.png index 515499b..84017d0 100644 Binary files a/fastlane/metadata/android/en-US/images/phoneScreenshots/config_screen.png and b/fastlane/metadata/android/en-US/images/phoneScreenshots/config_screen.png differ diff --git a/fastlane/metadata/android/en-US/images/phoneScreenshots/main_screen.png b/fastlane/metadata/android/en-US/images/phoneScreenshots/main_screen.png index bf94bc8..db2848b 100644 Binary files a/fastlane/metadata/android/en-US/images/phoneScreenshots/main_screen.png and b/fastlane/metadata/android/en-US/images/phoneScreenshots/main_screen.png differ diff --git a/fastlane/metadata/android/en-US/images/phoneScreenshots/settings_screen.png b/fastlane/metadata/android/en-US/images/phoneScreenshots/settings_screen.png index b9d5266..81188ec 100644 Binary files a/fastlane/metadata/android/en-US/images/phoneScreenshots/settings_screen.png and b/fastlane/metadata/android/en-US/images/phoneScreenshots/settings_screen.png differ diff --git a/fastlane/metadata/android/en-US/images/phoneScreenshots/support_screen.png b/fastlane/metadata/android/en-US/images/phoneScreenshots/support_screen.png index 8970125..1b39ea8 100644 Binary files a/fastlane/metadata/android/en-US/images/phoneScreenshots/support_screen.png and b/fastlane/metadata/android/en-US/images/phoneScreenshots/support_screen.png differ