summaryrefslogtreecommitdiff
path: root/wrappers/swift/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'wrappers/swift/README.md')
-rw-r--r--wrappers/swift/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/wrappers/swift/README.md b/wrappers/swift/README.md
new file mode 100644
index 0000000..8259592
--- /dev/null
+++ b/wrappers/swift/README.md
@@ -0,0 +1,27 @@
+# Swift wrapper
+
+## Requirements
+
+You will need to install the [Swift SDK](https://www.swift.org/getting-started), which includes the `swift` tool.
+
+## Build & test
+
+Build `EduVpnCommon` using shared Go library for current platform:
+
+```shell
+make
+```
+
+Build `EduVpnCommon` using shared Go library for specified platform, e.g.:
+
+```shell
+make GOOS=linux GOARCH=amd64
+```
+
+On Windows, you will also need to generate a .lib for the .dll.
+
+Test:
+
+```shell
+make test
+```