aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorLinus Jahn <lnj@kaidan.im>2022-08-16 14:50:04 +0200
committerLinus Jahn <lnj@kaidan.im>2022-08-16 15:08:51 +0200
commit5178274935b0dd5ad56c04b7c14f491025ab6438 (patch)
treee3f7fe3e788be45ede5248ed2405657e19a613b5 /src
parent64b69d0d0d3f61aae37969f5e339d6ea33b4a5cf (diff)
downloadqxmpp-5178274935b0dd5ad56c04b7c14f491025ab6438.tar.gz
Describe OMEMO specific dependencies in READMEs
Diffstat (limited to 'src')
-rw-r--r--src/omemo/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/src/omemo/README.md b/src/omemo/README.md
index 57ffc9c2..609c8c24 100644
--- a/src/omemo/README.md
+++ b/src/omemo/README.md
@@ -1,6 +1,23 @@
QXmpp OMEMO module
==================
+The QXmpp OMEMO module adds support for OMEMO (v0.8+) end-to-end encryption by
+providing the `QXmppOmemoManager`.
+
+Dependencies
+------------
+
+ * [QCA (Qt Cryptographic Architecture)](https://invent.kde.org/libraries/qca)
+ * [libomemo-c](https://github.com/dino/libomemo-c)
+
+Building
+--------
+
+By default QXmpp is built without the OMEMO module. To enable it you need to
+provide `-DBUILD_OMEMO=ON` to cmake:
+
+ cmake <qxmpp folder> -DBUILD_OMEMO=ON
+
Usage
-----