Commit eeab345a authored by Daniel Brötzmann's avatar Daniel Brötzmann Committed by Philipp Hörist

Update README.md

parent 8c4bbc69
## Welcome to python-nbxmpp website
# Welcome to python-nbxmpp
python-nbxmpp is a Python library that provides a way for Python applications to use Jabber/XMPP networks in a non-blocking way. This library is initialy a fork of xmpppy one, but using non-blocking sockets.
`python-nbxmpp` is a Python library that provides a way for Python applications to use the Jabber/XMPP network in a non-blocking way. This library was initialy a fork of `xmpppy`, but is now using non-blocking sockets.
## Features
* Asynchronous
* Supports ANONYMOUS, EXTERNAL, GSSAPI, SCRAM-SHA-1(PLUS), SCRAM-SHA-256(PLUS) and PLAIN authentication mechanisms.
* Supports connection via proxies
* Suppors TLS
* Supports [BOSH (XEP-0124)](https://xmpp.org/extensions/xep-0124.html)
* Support [Stream Management (XEP-0198)](https://xmpp.org/extensions/xep-0198.html)
* Asynchronous
* Supports ANONYMOUS, EXTERNAL, GSSAPI, SCRAM-SHA-1, DIGEST-MD5, PLAIN, and X-MESSENGER-OAUTH2 authentication mechanisms.
* Supports connection via proxies
* Supports TLS
* Supports [BOSH (XEP-0124)](https://xmpp.org/extensions/xep-0124.html)
* Supports [Stream Managemen (XEP-0198)](https://xmpp.org/extensions/xep-0198.html)
* List of [supported XEPs](./Supported-XEPs-in-python-nbxmpp/)
## Starting Points
* [Downloads](http://dev.gajim.org/gajim/python-nbxmpp/tags)
* You can also clone the git repository at http://dev.gajim.org/gajim/python-nbxmpp.git
* [Example](http://dev.gajim.org/gajim/python-nbxmpp/tree/master/doc/examples)
\ No newline at end of file
* [Downloads](https://dev.gajim.org/gajim/python-nbxmpp/tags)
* You can also clone the [git repository](https://dev.gajim.org/gajim/python-nbxmpp.git)
* [Examples](https://dev.gajim.org/gajim/python-nbxmpp/tree/master/doc/examples)
### Setup
Run the following:
sudo python setup.py install
### Usage
To use python-nbxmpp, `import nbxmpp` in your application. Have a look at the [Examples](https://dev.gajim.org/gajim/python-nbxmpp/tree/master/doc/examples) in the doc folder.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment