moxxmpp/README.md

28 lines
870 B
Markdown

# moxxmpp
moxxmpp is a XMPP library written purely in Dart for usage in Moxxy.
## Packages
### moxxmpp
This package contains the actual XMPP code that is platform-independent.
### moxxmpp_socket
`moxxmpp_socket` contains the implementation of the `BaseSocketWrapper` class that
implements the RFC6120 connection algorithm and XEP-0368 direct TLS connections,
if a DNS implementation is given, and supports StartTLS.
## Development
To begin, use [melos](https://github.com/invertase/melos) to bootstrap the project: `melos bootstrap`. Then, the example
can be run with `flutter run` on Linux or Android.
To run the example, make sure that Flutter is correctly set up and working. If you use
the development shell provided by the NixOS Flake, ensure that `ANDROID_HOME` and
`ANDROID_AVD_HOME` are pointing to the correct directories.
## License
See `./LICENSE`.