From 2a8895ffbc6148164df21121c9febbcb97ba0271 Mon Sep 17 00:00:00 2001 From: Zane Schepke Date: Sat, 30 Mar 2024 23:16:19 -0400 Subject: [PATCH] docs: update readme, add security --- README.md | 10 ++++++---- SECURITY.md | 5 +++++ 2 files changed, 11 insertions(+), 4 deletions(-) create mode 100644 SECURITY.md diff --git a/README.md b/README.md index 8759ef2..a7c6a64 100644 --- a/README.md +++ b/README.md @@ -49,16 +49,18 @@ and on while on different networks. This app was created to offer a free solutio ## Features * Add tunnels via .conf file, zip, manual entry, or QR code -* Auto connect to VPN based on Wi-Fi SSID, ethernet, or mobile data +* Auto connect to tunnels based on Wi-Fi SSID, ethernet, or mobile data * Split tunneling by application with search * WireGuard support for kernel and userspace modes * Always-On VPN support * Export tunnels to zip -* Quick tile support for VPN toggling -* Static shortcuts support for primary tunnel for automation integration +* Quick tile support for tunnel toggling, auto-tunneling +* Static shortcuts support for tunnel toggling, auto-tunneling * Intent automation support for all tunnels -* Automatic service restart after reboot +* Automatic auto-tunneling service restart after reboot +* Automatic tunnel restart after reboot * Battery preservation measures +* Restart tunnel on ping failure (beta) ## Docs (WIP) diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..e80ff1e --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,5 @@ +# Security Policy + +## Reporting a Vulnerability + +Please report security issues to `support@zaneschepke.com` \ No newline at end of file