Add macOS-specific instructions to README.md (#6)

* Update README.md
This commit is contained in:
Dave Gallant
2021-01-01 13:19:36 -05:00
committed by GitHub
parent 809fd6eec9
commit 4d801a3675

View File

@@ -8,7 +8,7 @@ This client fetches the list of available relay servers provided by vpngate.net.
![image](https://user-images.githubusercontent.com/4519234/103308641-e47f9300-49e0-11eb-8ff2-77c6e3e8cc7b.png)
Once connected, you can check out your IP address: https://nordvpn.com/what-is-my-ip/
Once connected, you can check out your IP address: https://nordvpn.com/what-is-my-ip/, or simply `curl ipinfo.io`.
## Requirements
@@ -17,8 +17,18 @@ Once connected, you can check out your IP address: https://nordvpn.com/what-is-m
## Install
Ensure that [go](https://golang.org/doc/install) is installed.
```sh
go get github.com/davegallant/vpngate
$ go get github.com/davegallant/vpngate
```
### MacOS
OpenVPN can be installed with [homebrew](https://brew.sh/).
```sh
$ brew install openvpn
```
## Usage
@@ -33,6 +43,8 @@ $ vpngate list
Because openvpn creates a network interface, run the connect command with `sudo` or a user with escalated privileges.
On macOS, export path by using `export PATH=$(brew --prefix openvpn)/sbin:$PATH` (this can be run each time in a terminal or put in a bash/zsh profile)
```sh
$ sudo vpngate connect
```