From 26810294e18486a858621dc385accca83f2c501f Mon Sep 17 00:00:00 2001 From: Jason Volk Date: Wed, 27 Jul 2022 13:43:34 -0700 Subject: [PATCH] README: Add project description subtitle. [ci skip] --- README.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 18418b976..34308afc9 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ # This — is The **Construct** +#### Federated Messaging Server + [![Chat in #construct:zemos.net](https://img.shields.io/matrix/construct:zemos.net.svg?label=Chat%20in%20%23construct%3Azemos.net&logo=matrix&server_fqdn=matrix.org&style=for-the-badge&color=5965AF)](https://matrix.to/#/#construct:zemos.net) [![](https://img.shields.io/badge/License-BSD-5965AF.svg?label=%20license&style=for-the-badge)]() -### 📦 GETTING STARTED +### 📦 RUN YOUR OWN [![](https://img.shields.io/badge/github-source-8891CD.svg?logo=GitHub&style=for-the-badge)](https://github.com/matrix-construct/construct) [![](https://img.shields.io/badge/docker-images-8891CD.svg?logo=Docker&style=for-the-badge)](https://registry.hub.docker.com/r/jevolk/construct) @@ -28,9 +30,9 @@ 3. ⚡ [TUNING](https://github.com/matrix-construct/construct/wiki/TUNING) guide to optimize Construct for your deployment. -🙋 [TROUBLESHOOTING](https://github.com/matrix-construct/construct/wiki/Troubleshooting-problems) guide for solutions to possible problems. +- 🙋 [TROUBLESHOOTING](https://github.com/matrix-construct/construct/wiki/Troubleshooting-problems) guide for solutions to possible problems. -❓ [FREQUENTLY ASKED QUESTIONS](https://github.com/matrix-construct/construct/wiki/FAQ) for answers to the most common perplexities. +- ❓ [FREQUENTLY ASKED QUESTIONS](https://github.com/matrix-construct/construct/wiki/FAQ) for answers to the most common perplexities. >🛑 Operating a Construct server which is open to public user registration is unsafe. Local users may be able to exceed resource limitations and deny service to other users. @@ -48,8 +50,3 @@ Browse to `doc/html/index.html`. - [x] **Personal**: Dozens of users. Few default restrictions; higher log output. - [ ] **Company**: Hundreds of users. Moderate default restrictions. - [ ] **Public**: Thousands of users. Untrusting configuration defaults. - -> Due to the breadth of the Matrix client/server protocol we can only endorse -production use of Construct gradually while local user restrictions are -developed. This notice applies to locally registered users connecting with -clients, it does not apply to federation.