Skip to content

Commit

Permalink
Update README to point to nio as an alternative library
Browse files Browse the repository at this point in the history
Moved documentation and chatroom to badges to make the recommendation
to use nio more prominent.

Signed-off-by: Adam Beckmeyer <adam_gpg@thebeckmeyers.xyz>
  • Loading branch information
non-Jedi committed Oct 9, 2019
1 parent 06580f7 commit a469d53
Showing 1 changed file with 19 additions and 14 deletions.
33 changes: 19 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,31 @@ Matrix Client SDK for Python
.. image:: https://coveralls.io/repos/github/matrix-org/matrix-python-sdk/badge.svg?branch=master
:target: https://coveralls.io/github/matrix-org/matrix-python-sdk?branch=master
:alt: coveralls.io Results
.. image:: https://img.shields.io/matrix/matrix-python-sdk:matrix.org
:target: https://matrix.to/#/%23matrix-python-sdk:matrix.org
:alt: Matrix chatroom
.. image:: https://img.shields.io/badge/docs-stable-blue
:target: https://matrix-org.github.io/matrix-python-sdk/
:alt: Documentation


This is a Matrix client-server SDK for Python 2.7 and 3.4+

Community discussion on usage of this SDK and development of this SDK can be
found at `#matrix-python-sdk:matrix.org`_.

Documentation can be found at http://matrix-org.github.io/matrix-python-sdk/

.. _`#matrix-python-sdk:matrix.org`: https://matrix.to/#/%23matrix-python-sdk:matrix.org
Matrix client-server SDK for Python 2.7 and 3.4+

Project Status
--------------

This sdk is currently lightly maintained (without any sort of official or
semi-official "lead" maintainer). In general pull-requests might be reviewed but
little to no new-feature or bug-fix development is happening outside of that.
For more info or to volunteer to help, please see
https://github.com/matrix-org/matrix-python-sdk/issues/279. Or come chat in
`#matrix-python-sdk:matrix.org`_.
We strongly recommend using the `matrix-nio`_ library rather than this
sdk. It is both more featureful and more actively maintained.

This sdk is currently lightly maintained without any person ultimately
responsible for the project. Pull-requests **may** be reviewed, but no
new-features or bug-fixes are being actively developed. For more info
or to volunteer to help, please see
https://github.com/matrix-org/matrix-python-sdk/issues/279 or come
chat in `#matrix-python-sdk:matrix.org`_.

.. _`matrix-nio`: https://github.com/poljar/matrix-nio
.. _`#matrix-python-sdk:matrix.org`: https://matrix.to/#/%23matrix-python-sdk:matrix.org

Installation
============
Expand Down

0 comments on commit a469d53

Please sign in to comment.