dbus-gmain: Add a README

Signed-off-by: Simon McVittie <smcv@debian.org>

1 files changed, 15 insertions, 0 deletions

diff --git a/dbus-gmain/README b/dbus-gmain/README
new file mode 100644
index 0000000..17919fe
--- /dev/null
+++ b/dbus-gmain/README
@@ -0,0 +1,15 @@
+dbus-gmain - GLib main loop integration for libdbus
+===================================================
+
+This directory contains GLib main loop integration for libdbus, salvaged
+from dbus-glib. At the moment it is designed to be bundled in other
+projects using the `git subtree` or `git submodule` commands.
+
+Please do not use this module unless you really need it. The majority
+of GLib-based D-Bus users would be better off using GDBus, part of GLib,
+instead of the low-level APIs provided by libdbus. In particular, the
+combination of dbus-gmain and libdbus is known to have thread-safety
+issues.
+
+However, using this module is still better than using dbus-glib; the
+rest of dbus-glib mostly consists of design flaws.