diff options
| author | Odd Stranne <odd@mullvad.net> | 2020-02-07 23:15:41 +0100 |
|---|---|---|
| committer | Odd Stranne <odd@mullvad.net> | 2020-02-13 11:29:23 +0100 |
| commit | 2781b614d5ffd6949385de3c5dd1ea2a6704ff3a (patch) | |
| tree | 6da6cc7adbafbd880253d5c65c7baf15cec61280 /wireguard | |
| parent | 82847119f3d17f5105db3c19bd25f1faf597e992 (diff) | |
| download | mullvadvpn-2781b614d5ffd6949385de3c5dd1ea2a6704ff3a.tar.xz mullvadvpn-2781b614d5ffd6949385de3c5dd1ea2a6704ff3a.zip | |
Add readme for libwg
Diffstat (limited to 'wireguard')
| -rw-r--r-- | wireguard/libwg/README.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/wireguard/libwg/README.md b/wireguard/libwg/README.md new file mode 100644 index 0000000000..e5b96928f7 --- /dev/null +++ b/wireguard/libwg/README.md @@ -0,0 +1,26 @@ +# Introduction + +`libwg` is a tiny wrapper around `wireguard-go`, with the main purpose of providing a simple FFI-friendly interface. + +It currently offers support for the following platforms: + +- Linux +- macOS +- Android +- Windows + +# Organization + +`libwg.go` has shared code that is used on all platforms. + +`libwg_default.go` has default implementations for Linux-based systems. + +`libwg_android.go` has code specifically for Android. + +`libwg_windows.go` has code specifically for Windows. + +# Usage + +Call `wgTurnOn` to create and activate a tunnel. The prototype is different on different platforms, see the code for details. + +Call `wgTurnOff` to destroy the tunnel. |