summaryrefslogtreecommitdiffstatshomepage
path: root/contrib/examples/embeddable-wg-library/README
diff options
context:
space:
mode:
authorJason A. Donenfeld <Jason@zx2c4.com>2018-02-15 13:50:12 +0100
committerJason A. Donenfeld <Jason@zx2c4.com>2018-02-17 05:55:03 +0100
commit418416a5c722d2de955ffa0ac71a0c2d1296375a (patch)
tree856f1ffd668c3d6f648cece174cdaeb16bcd924f /contrib/examples/embeddable-wg-library/README
parentwg(8): clarify phrasing (diff)
downloadwireguard-monolithic-historical-418416a5c722d2de955ffa0ac71a0c2d1296375a.tar.xz
wireguard-monolithic-historical-418416a5c722d2de955ffa0ac71a0c2d1296375a.zip
contrib: add embeddable wireguard library
Diffstat (limited to 'contrib/examples/embeddable-wg-library/README')
-rw-r--r--contrib/examples/embeddable-wg-library/README23
1 files changed, 23 insertions, 0 deletions
diff --git a/contrib/examples/embeddable-wg-library/README b/contrib/examples/embeddable-wg-library/README
new file mode 100644
index 0000000..453dc8e
--- /dev/null
+++ b/contrib/examples/embeddable-wg-library/README
@@ -0,0 +1,23 @@
+Embeddable WireGuard C Library
+==============================
+
+This is a mini single-file library, meant to be embedded directly into the
+source code of your program. It is *not* meant to be built as a shared
+library.
+
+
+Usage
+-----
+
+Copy wireguard.c and wireguard.h into your project. They should build with
+any C89 compiler. There are no dependencies except libc.
+
+Please see the set of simple functions in wireguard.h for information on
+how to use, as well as the example code in test.c.
+
+
+License
+-------
+
+Because this uses code from libmnl, wireguard.c and wireguard.h are licensed
+under the LGPL-2.1+.