From 1a672677e0556f919f25a55e763a074bf92edf13 Mon Sep 17 00:00:00 2001 From: "Alexander \"PapaTutuWawa" Date: Fri, 5 Aug 2022 18:26:20 +0200 Subject: [PATCH] docs: Update README --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b6ff641..dc455e4 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,23 @@ # omemo_dart -Hopefully, a library enabling developers to build OMEMO-supporting -XMPP clients in Dart and Flutter. +`omemo_dart` is a Dart library to help developers of Dart/Flutter XMPP clients to implement +[OMEMO](https://xmpp.org/extensions/xep-0384.html) in its newest version - currently 0.8.3. -**Please note that this library has not been audited for its security! Use at your own risk!** +The library provides an implementation of the [X3DH](https://signal.org/docs/specifications/x3dh/) +key exchange, the [Double Ratchet](https://signal.org/docs/specifications/doubleratchet/) with +the OMEMO 0.8.3 specific `ENCRYPT`, `DECRYPT` and `KDF_*` functions and a very high-level +`OmemoSessionManager` that manages all Double Ratchet sessions and provides a clean and simple +interface for encrypting a message for all known Ratchet sessions we have with a user. + +This library also has no dependency on any XMPP library. `omemo_dart` instead defines an +intermediary format for the required data, that you, the user, will need to transform between +the stanza format of your preferred XMPP library and `omemo_dart`'s intermediary format +yourself. + +## Important Notes + +- **Please note that this library has not been audited for its security! Use at your own risk!** +- This library is not tested with other implementations of OMEMO 0.8.3 as I do not know of any client implementing spec compliant OMEMO 0.8.3. It does, however, work with itself. ## Contributing