summary refs log tree commit diff
path: root/README.rst
diff options
context:
space:
mode:
authorMateusz PrzybyƂowicz <uamfhq@gmail.com>2020-10-08 12:16:56 +0200
committerGitHub <noreply@github.com>2020-10-08 11:16:56 +0100
commit719474cae0f9fd958cef1279ad559866e184e9e9 (patch)
tree8aeebdd1940e2d0c3fc1851fa2902be3a1cd387b /README.rst
parentClarify error message when plugin config parsers raise an error (#8492) (diff)
downloadsynapse-719474cae0f9fd958cef1279ad559866e184e9e9.tar.xz
Add useful shields to readme (#8493)
Added shields directing to synapse-dev room, showing license, latest version on PyPi and supported Python versions.
I've moved substitution definitions to the bottom to improve readability.

Signed-off-by: Mateusz PrzybyƂowicz <uamfhq@gmail.com>
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst30
1 files changed, 23 insertions, 7 deletions
diff --git a/README.rst b/README.rst
index e623cf863a..d609b4b62e 100644
--- a/README.rst
+++ b/README.rst
@@ -1,10 +1,6 @@
-================
-Synapse |shield|
-================
-
-.. |shield| image:: https://img.shields.io/matrix/synapse:matrix.org?label=support&logo=matrix
-  :alt: (get support on #synapse:matrix.org)
-  :target: https://matrix.to/#/#synapse:matrix.org
+=========================================================
+Synapse |support| |development| |license| |pypi| |python|
+=========================================================
 
 .. contents::
 
@@ -374,3 +370,23 @@ something like the following in their logs::
 
 This is normally caused by a misconfiguration in your reverse-proxy. See
 `<docs/reverse_proxy.md>`_ and double-check that your settings are correct.
+
+.. |support| image:: https://img.shields.io/matrix/synapse:matrix.org?label=support&logo=matrix
+  :alt: (get support on #synapse:matrix.org)
+  :target: https://matrix.to/#/#synapse:matrix.org
+
+.. |development| image:: https://img.shields.io/matrix/synapse-dev:matrix.org?label=development&logo=matrix
+  :alt: (discuss development on #synapse-dev:matrix.org)
+  :target: https://matrix.to/#/#synapse-dev:matrix.org
+
+.. |license| image:: https://img.shields.io/github/license/matrix-org/synapse
+  :alt: (check license in LICENSE file)
+  :target: LICENSE
+
+.. |pypi| image:: https://img.shields.io/pypi/v/matrix-synapse
+  :alt: (latest version released on PyPi)
+  :target: https://pypi.org/project/matrix-synapse
+
+.. |python| image:: https://img.shields.io/pypi/pyversions/matrix-synapse
+  :alt: (supported python versions)
+  :target: https://pypi.org/project/matrix-synapse