summary refs log tree commit diff
path: root/src/libnm-client-public/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/libnm-client-public/README.md')
-rw-r--r--src/libnm-client-public/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/libnm-client-public/README.md b/src/libnm-client-public/README.md
new file mode 100644
index 00000000..a4ecb066
--- /dev/null
+++ b/src/libnm-client-public/README.md
@@ -0,0 +1,16 @@
+libnm-client-public
+===================
+
+libnm is NetworkManager's client API. It has a public API.
+This API consists of two parts:
+
+- the handling of connections (`NMConnection`), implemented
+  by libnm-core-impl.
+- the caching of D-Bus API (`NMClient`), implemented by
+  libnm-client-impl.
+
+This directory contains public headers that are used by libnm
+users. As such, it's the `NMClient` part of libnm-core-public.
+
+These headers are usable to any libnm client application and
+to libnm itself. But not to libnm-core-impl or the daemon.