From f54a90d5bbd09b0e6bc2a6458bc3f1469024f9a2 Mon Sep 17 00:00:00 2001 From: "Alexander \"PapaTutuWawa" Date: Sun, 18 Jun 2023 21:24:50 +0200 Subject: [PATCH] docs: Add a reference to moxxmpp's OMEMO example --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 022c9a3..65529ef 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,12 @@ dependencies: # [...] ``` +### Example + +This repository includes a documented ["example"](./example/omemo_dart_example.dart) that explains the basic usage of the library while +leaving out the XMPP specific bits. For a more functional and integrated example, see the `omemo_client.dart` example from +[moxxmpp](https://codeberg.org/moxxy/moxxmpp). + ### Persistence By default, `omemo_dart` uses in-memory implementations for everything. For a real-world application, this is unsuitable as OMEMO devices would be constantly added.