Files
nym/nym-vpn/android/README.md
pierre b9a9a407e9 init
2023-09-06 20:01:58 +02:00

43 lines
1.0 KiB
Markdown

## NymConnect for Android
### Prerequisites
_TODO_
### Getting started
[Install](https://developer.android.com/studio/install) Android Studio and open
the project.\
Setup an android emulator using AVD.\
[Run](https://developer.android.com/studio/run/emulator) the project.
**⚠ NOTE**: be sure
to [set](https://developer.android.com/studio/run#changing-variant)
the build variant to `x86_64Debug` when running on emulator
### Features
* Add tunnels via .conf file
* Auto connect to VPN based on Wi-Fi SSID
* Split tunneling by application with search
* Always-on VPN for Android support
* Quick tile support for vpn toggling
* Dynamic shortcuts support for automation integration
* Configurable Trusted Network list
* Optional auto connect on mobile data
* Automatic service restart after reboot
* Service will stay running in background after app has been closed
### Building
_TODO_
### Credits
This project is based on the "WG Tunnel" project made by Zane Schepke
https://github.com/zaneschepke/wgtunnel
### License
MIT