Skip to content

Commit 41981c6

Browse files
committed
Update README for version 3.0
1 parent 4f098c3 commit 41981c6

File tree

4 files changed

+11
-20
lines changed

4 files changed

+11
-20
lines changed

README.md

+11-20
Original file line numberDiff line numberDiff line change
@@ -56,31 +56,23 @@ brew install --cask timac/vpnstatus/vpnstatus
5656
```
5757

5858

59-
# Retry Delay
59+
# Settings window
6060

61-
VPNStatus tries to reconnect to the VPN every 120s by default. You can change this value using a secret preference. To change the retry delay to 30s:
61+
VPNStatus lets you tweak the settings in the preferences window:
6262

63-
- Quit VPNStatus
64-
- Run this command in a Terminal window:
63+
![](Screenshots/SettingsGeneral.png)
6564

66-
```
67-
defaults write org.timac.VPNStatus AlwaysConnectedRetryDelay -int 30
68-
```
6965

70-
Note that the minimum valid value for `AlwaysConnectedRetryDelay` is 11. If you use a lower value, the default value (120s) will be used.
66+
# Retry Delay
7167

72-
# Ignored SSIDs
68+
VPNStatus tries to reconnect to the VPN every 120s by default. You can change this value in the settings.
7369

74-
VPNStatus can optionally ignore one or more SSIDs, such that services are **not** autoconnected when the current Wi-Fi SSID is on the ignored list.
7570

76-
To set the list of ignored SSIDs:
71+
# Ignored SSIDs
7772

78-
- Quit VPNStatus
79-
- Run this command in a Terminal window:
73+
VPNStatus can optionally ignore one or more SSIDs, such that services are **not** autoconnected when the current Wi-Fi SSID is on the ignored list.
8074

81-
```
82-
defaults write org.timac.VPNStatus IgnoredSSIDs "OneSSID,SecondSSID,Third SSID"
83-
```
75+
![](Screenshots/SettingsSSIDs.png)
8476

8577
With the above example, if the current Wi-Fi network SSID is `OneSSID`, `SecondSSID`, or `Third SSID`, then the VPN will **not** autoconnect.
8678

@@ -91,12 +83,11 @@ Note that SSIDs **are** case-sensitive.
9183
Starting in macOS 14 Sonoma, reading the Wi-Fi SSID requires Location Services access. Without the Location Services access enabled, VPNStatus can't ignore SSIDs while autoconnecting. VPNStatus now checks the Location Services authorization and displays a menu item to grant the permissions.
9284

9385

86+
9487
# Hide VPNs
9588

9689
There are some VPN configurations that you might not want to see in VPNStatus. This is the case of third-party content filter configurations like Little Snitch.
9790

98-
By default, VPNStatus will hide the Little Snitch content filter configuration. You can override the preference to hide more VPN configurations. Example:
91+
By default, VPNStatus will hide the Little Snitch content filter configuration. You can override the preference to hide more VPN configurations:
9992

100-
```
101-
defaults write org.timac.VPNStatus IgnoredVPNs "Little Snitch,HiddenVPN,AnotherHiddenVPN"
102-
```
93+
![](Screenshots/SettingsVPNs.png)

Screenshots/SettingsGeneral.png

250 KB
Loading

Screenshots/SettingsSSIDs.png

232 KB
Loading

Screenshots/SettingsVPNs.png

229 KB
Loading

0 commit comments

Comments
 (0)