summaryrefslogtreecommitdiff
path: root/src/libnm-client-aux-extern/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/libnm-client-aux-extern/README.md')
-rw-r--r--src/libnm-client-aux-extern/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/src/libnm-client-aux-extern/README.md b/src/libnm-client-aux-extern/README.md
new file mode 100644
index 0000000000..460b269e6d
--- /dev/null
+++ b/src/libnm-client-aux-extern/README.md
@@ -0,0 +1,15 @@
+nm-libnm-aux is a static library that:
+
+ - uses the public parts of "libnm"
+ - that can also be statically linked into other users of libnm.
+
+Basically, it is a static library with utility functions that extends
+libnm.
+
+That means:
+
+ - you can use it everywhere where you dynamically link with libnm.
+
+Also, since nm-libnm-aux itself only uses public (stable)
+API of libnm, you theoretically can copy the sources into your
+own source tree.