# XMPP

[![GoDoc](https://godoc.org/mellium.im/xmpp?status.svg)][docs]
[![Chat](https://inverse.chat/badge.svg?room=mellium@conference.samwhited.com)](https://conversations.im/j/mellium@conference.samwhited.com)
[![License](https://img.shields.io/badge/license-FreeBSD-blue.svg)](https://opensource.org/licenses/BSD-2-Clause)
[![Build Status](https://builds.sr.ht/~samwhited/xmpp.svg)](https://builds.sr.ht/~samwhited/xmpp?)

[![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/purple_img.png)](https://www.buymeacoffee.com/samwhited)
[![Support Me](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/SamWhited/donate)


An XMPP library in Go.

To use it in your project, import it (or any of its other packages) like so:

```go
import mellium.im/xmpp
```

If you're looking to get started and need some help, see the [API docs][docs] or
look in the `examples/` tree for several simple usage examples.

If you'd like to contribute to the project, see [CONTRIBUTING.md].


## License

The package may be used under the terms of the BSD 2-Clause License a copy of
which may be found in the file "[LICENSE]".
Some code in this package has been copied from Go and is used under the terms of
Go's modified BSD license, a copy of which can be found in the [LICENSE-GO]
file.

Unless you explicitly state otherwise, any contribution submitted for inclusion
in the work by you shall be licensed as above, without any additional terms or
conditions.


[docs]: https://pkg.go.dev/mellium.im/xmpp
[CONTRIBUTING.md]: https://mellium.im/docs/CONTRIBUTING
[LICENSE]: https://github.com/mellium/xmpp/blob/master/LICENSE
[LICENSE-GO]: https://github.com/mellium/xmpp/blob/master/LICENSE-GO