diff options
| -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. |