Add README for omemo module

1 files changed, 25 insertions, 0 deletions

diff --git a/src/omemo/README.md b/src/omemo/README.md
new file mode 100644
index 00000000..57ffc9c2
--- /dev/null
+++ b/src/omemo/README.md
@@ -0,0 +1,25 @@
+QXmpp OMEMO module
+==================
+
+Usage
+-----
+
+QXmpp OMEMO is available as a CMake module. You can use it like this:
+
+```cmake
+find_package(QXmpp COMPONENTS Omemo)
+target_link_libraries(${PROJECT} PRIVATE QXmpp::QXmpp QXmpp::Omemo)
+```
+
+How to use the OMEMO Manager is explained in the code documentation.
+
+Licensing issues
+----------------
+
+QXmppOmemo itself is (like the core) licensed under LGPL-2.1-or-later. However,
+as of today it is linking to `libomemo-c` which uses GPL-3.0. *This means that
+the resulting binaries must be used under the terms of the **GPL-3.0**.*
+
+We might move to a different, more permissive OMEMO library in the future and
+in that case no relicensing would be necessary.
+