1# xmpp-rs
 2
 3## What's this?
 4
 5A set of rust XMPP libraries with the goals of being type-safe and well-tested.
 6
 7- `xmpp` provides a high-level API for the protocol. You shouldn't need to
 8  know about the protocol to use it. Still very much WIP.
 9- `tokio-xmpp` is a lower-level library that handles the XMPP stream(s).
10- `xmpp-parsers` parses XML into Rust and back.
11- `minidom` is a DOM library quite specific for XMPP.
12- `jid` is a Jid parsing library.
13- `sasl` handles the SASL protocol.
14- `xso` and `xso-proc` provide the procedural macros powering `xmpp-parsers`.
15
16## Community
17
18There is an XMPP MUC for the discussion of these libraries, feel free to join! :)
19
20[chat@xmpp.rs](xmpp:chat@xmpp.rs?join)
21
22A Code of Conduct is available as
23[CODE\_OF\_CONDUCT.md](https://gitlab.com/xmpp-rs/xmpp-rs/-/raw/main/CODE_OF_CONDUCT.md)
24in the repository for the well-being of the community. Please refer to it in
25case of a possible conflict in any of the xmpp-rs venues (channel, forge,
26etc.).
27
28### Contributing
29
30Thank you for your interest in the project!
31
32Contributing rules are available as
33[CONTRIBUTING.md](https://gitlab.com/xmpp-rs/xmpp-rs/-/raw/main/CONTRIBUTING.md) in the repository.
34
35## License
36
37Mozilla Public License 2 (MPL2). See the LICENSE file.
38
39## Building
40
41Dependencies should be provided by crates if you use the default features. If
42you use tokio-xmpp's `tls-native` feature you will need an ssl library
43(openssl, libressl, etc.).
44
45```
46cargo build
47```
48
49The various features available should be explained in the crates themselves.