Skip to content

Commit a412a58

Browse files
Update the README with Element branding and a few fixes (#17324)
Co-authored-by: Hugh Nimmo-Smith <hughns@element.io>
1 parent 7ef89b9 commit a412a58

File tree

2 files changed

+51
-25
lines changed

2 files changed

+51
-25
lines changed

README.rst

Lines changed: 50 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,34 @@
1-
=========================================================================
2-
Synapse |support| |development| |documentation| |license| |pypi| |python|
3-
=========================================================================
4-
5-
Synapse is an open-source `Matrix <https://matrix.org/>`_ homeserver written and
6-
maintained by the Matrix.org Foundation. We began rapid development in 2014,
7-
reaching v1.0.0 in 2019. Development on Synapse and the Matrix protocol itself continues
8-
in earnest today.
9-
10-
Briefly, Matrix is an open standard for communications on the internet, supporting
11-
federation, encryption and VoIP. Matrix.org has more to say about the `goals of the
12-
Matrix project <https://matrix.org/docs/guides/introduction>`_, and the `formal specification
13-
<https://spec.matrix.org/>`_ describes the technical details.
1+
.. image:: https://github.com/element-hq/product/assets/87339233/7abf477a-5277-47f3-be44-ea44917d8ed7
2+
:height: 60px
3+
4+
===========================================================================================================
5+
Element Synapse - Matrix homeserver implementation |support| |development| |documentation| |license| |pypi| |python|
6+
===========================================================================================================
7+
8+
Synapse is an open source `Matrix <https://matrix.org>`_ homeserver
9+
implementation, written and maintained by `Element <https://element.io>`_.
10+
`Matrix <https://github.com/matrix-org>`_ is the open standard for
11+
secure and interoperable real time communications. You can directly run
12+
and manage the source code in this repository, available under an AGPL
13+
license. There is no support provided from Element unless you have a
14+
subscription.
15+
16+
Subscription alternative
17+
------------------------
18+
19+
Alternatively, for those that need an enterprise-ready solution, Element
20+
Server Suite (ESS) is `available as a subscription <https://element.io/pricing>`_.
21+
ESS builds on Synapse to offer a complete Matrix-based backend including the full
22+
`Admin Console product <https://element.io/enterprise-functionality/admin-console>`_,
23+
giving admins the power to easily manage an organization-wide
24+
deployment. It includes advanced identity management, auditing,
25+
moderation and data retention options as well as Long Term Support and
26+
SLAs. ESS can be used to support any Matrix-based frontend client.
1427

1528
.. contents::
1629

17-
Installing and configuration
18-
============================
30+
🛠️ Installing and configuration
31+
===============================
1932

2033
The Synapse documentation describes `how to install Synapse <https://element-hq.github.io/synapse/latest/setup/installation.html>`_. We recommend using
2134
`Docker images <https://element-hq.github.io/synapse/latest/setup/installation.html#docker-images-and-ansible-playbooks>`_ or `Debian packages from Matrix.org
@@ -105,8 +118,8 @@ Following this advice ensures that even if an XSS is found in Synapse, the
105118
impact to other applications will be minimal.
106119

107120

108-
Testing a new installation
109-
==========================
121+
🧪 Testing a new installation
122+
============================
110123

111124
The easiest way to try out your new Synapse installation is by connecting to it
112125
from a web client.
@@ -159,8 +172,20 @@ the form of::
159172
As when logging in, you will need to specify a "Custom server". Specify your
160173
desired ``localpart`` in the 'User name' box.
161174

162-
Troubleshooting and support
163-
===========================
175+
🎯 Troubleshooting and support
176+
=============================
177+
178+
🚀 Professional support
179+
----------------------
180+
181+
Enterprise quality support for Synapse including SLAs is available as part of an
182+
`Element Server Suite (ESS) <https://element.io/pricing>` subscription.
183+
184+
If you are an existing ESS subscriber then you can raise a `support request <https://ems.element.io/support>`
185+
and access the `knowledge base <https://ems-docs.element.io>`.
186+
187+
🤝 Community support
188+
-------------------
164189

165190
The `Admin FAQ <https://element-hq.github.io/synapse/latest/usage/administration/admin_faq.html>`_
166191
includes tips on dealing with some common problems. For more details, see
@@ -176,8 +201,8 @@ issues for support requests, only for bug reports and feature requests.
176201
.. |docs| replace:: ``docs``
177202
.. _docs: docs
178203

179-
Identity Servers
180-
================
204+
🪪 Identity Servers
205+
==================
181206

182207
Identity servers have the job of mapping email addresses and other 3rd Party
183208
IDs (3PIDs) to Matrix user IDs, as well as verifying the ownership of 3PIDs
@@ -206,8 +231,8 @@ an email address with your account, or send an invite to another user via their
206231
email address.
207232

208233

209-
Development
210-
===========
234+
🛠️ Development
235+
==============
211236

212237
We welcome contributions to Synapse from the community!
213238
The best place to get started is our
@@ -225,8 +250,8 @@ Alongside all that, join our developer community on Matrix:
225250
`#synapse-dev:matrix.org <https://matrix.to/#/#synapse-dev:matrix.org>`_, featuring real humans!
226251

227252

228-
.. |support| image:: https://img.shields.io/matrix/synapse:matrix.org?label=support&logo=matrix
229-
:alt: (get support on #synapse:matrix.org)
253+
.. |support| image:: https://img.shields.io/badge/matrix-community%20support-success
254+
:alt: (get community support in #synapse:matrix.org)
230255
:target: https://matrix.to/#/#synapse:matrix.org
231256

232257
.. |development| image:: https://img.shields.io/matrix/synapse-dev:matrix.org?label=development&logo=matrix

changelog.d/17324.misc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update the README with Element branding, improve headers and fix the #synapse:matrix.org support room link rendering.

0 commit comments

Comments
 (0)