PapaTutuWawa/omemo_dart
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Add note about using omemo_dart

Browse Source
This commit is contained in:
PapaTutuWawa 2022-08-09 16:05:05 +02:00
parent e3de50e0c7
commit fc842fe000
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -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!** - **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. - 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 ## Contributing
Due to issues with `protobuf`, `omemo_dart` reimplements the Protobuf encoding for the required Due to issues with `protobuf`, `omemo_dart` reimplements the Protobuf encoding for the required