From fc842fe00030b2bf648cb2f98261539e10b64b02 Mon Sep 17 00:00:00 2001 From: "Alexander \"PapaTutuWawa" Date: Tue, 9 Aug 2022 16:05:05 +0200 Subject: [PATCH] docs: Add note about using omemo_dart --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 52f3f1d..14e1603 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,22 @@ the stanza format of your preferred XMPP library yourself. - **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. +## Usage + +Include `omemo_dart` in your `pubspec.yaml` like this: + +```yaml +# [...] + +dependencies: + omemo_dart: + hosted: https://git.polynom.me/api/packages/PapaTutuWawa/pub + version: ^0.1.0 + # [...] + +# [...] +``` + ## Contributing Due to issues with `protobuf`, `omemo_dart` reimplements the Protobuf encoding for the required