1xmpp-rs
2=======
3
4What's this?
5------------
6
7A very much WIP set of rust XMPP library with the goals of being type-safe and
8well-tested.
9
10- `xmpp-rs` provides a high-level API for the protocol. You shouldn't need to
11 know about the protocol to use it.
12- `tokio-xmpp` is a lower-level library that handles the XMPP stream(s).
13- `xmpp-parsers` parses XML into Rust and back.
14- `minidom` is a DOM library quite specific for XMPP
15- `jid` is a Jid parsing library.
16
17Contact
18-------
19
20There is an XMPP MUC for the discussion of this library, feel free to join! :)
21
22[chat@xmpp.rs](xmpp:chat@xmpp.rs?join)
23
24Community
25---------
26
27A Code of Conduct is available as
28[CODE\_OF\_CONDUCT.md](https://gitlab.com/xmpp-rs/xmpp-rs/-/raw/main/CODE_OF_CONDUCT.md)
29in the repository for the well-being of the community. Please refer to it in
30case of a possible conflict in any of the xmpp-rs venues (channel, forge,
31etc.).
32
33License
34-------
35
36Mozilla Public License 2 (MPL2). See the LICENSE file.
37
38Building
39--------
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.
50
51Contributing
52------------
53
54Thank you for your interest in the project!
55
56Contributing rules are available as
57[CONTRIBUTING.md](https://gitlab.com/xmpp-rs/xmpp-rs/-/raw/main/CONTRIBUTING.md) in the repository.