Skip to content

Commit a469d53

Browse files
committed
Update README to point to nio as an alternative library
Moved documentation and chatroom to badges to make the recommendation to use nio more prominent. Signed-off-by: Adam Beckmeyer <adam_gpg@thebeckmeyers.xyz>
1 parent 06580f7 commit a469d53

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

README.rst

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,31 @@ Matrix Client SDK for Python
1010
.. image:: https://coveralls.io/repos/github/matrix-org/matrix-python-sdk/badge.svg?branch=master
1111
:target: https://coveralls.io/github/matrix-org/matrix-python-sdk?branch=master
1212
:alt: coveralls.io Results
13+
.. image:: https://img.shields.io/matrix/matrix-python-sdk:matrix.org
14+
:target: https://matrix.to/#/%23matrix-python-sdk:matrix.org
15+
:alt: Matrix chatroom
16+
.. image:: https://img.shields.io/badge/docs-stable-blue
17+
:target: https://matrix-org.github.io/matrix-python-sdk/
18+
:alt: Documentation
1319

1420

15-
This is a Matrix client-server SDK for Python 2.7 and 3.4+
16-
17-
Community discussion on usage of this SDK and development of this SDK can be
18-
found at `#matrix-python-sdk:matrix.org`_.
19-
20-
Documentation can be found at http://matrix-org.github.io/matrix-python-sdk/
21-
22-
.. _`#matrix-python-sdk:matrix.org`: https://matrix.to/#/%23matrix-python-sdk:matrix.org
21+
Matrix client-server SDK for Python 2.7 and 3.4+
2322

2423
Project Status
2524
--------------
2625

27-
This sdk is currently lightly maintained (without any sort of official or
28-
semi-official "lead" maintainer). In general pull-requests might be reviewed but
29-
little to no new-feature or bug-fix development is happening outside of that.
30-
For more info or to volunteer to help, please see
31-
https://github.com/matrix-org/matrix-python-sdk/issues/279. Or come chat in
32-
`#matrix-python-sdk:matrix.org`_.
26+
We strongly recommend using the `matrix-nio`_ library rather than this
27+
sdk. It is both more featureful and more actively maintained.
28+
29+
This sdk is currently lightly maintained without any person ultimately
30+
responsible for the project. Pull-requests **may** be reviewed, but no
31+
new-features or bug-fixes are being actively developed. For more info
32+
or to volunteer to help, please see
33+
https://github.com/matrix-org/matrix-python-sdk/issues/279 or come
34+
chat in `#matrix-python-sdk:matrix.org`_.
35+
36+
.. _`matrix-nio`: https://github.com/poljar/matrix-nio
37+
.. _`#matrix-python-sdk:matrix.org`: https://matrix.to/#/%23matrix-python-sdk:matrix.org
3338

3439
Installation
3540
============

0 commit comments

Comments
 (0)