From 9a7a07a82478e191581912ce370e54e43985b635 Mon Sep 17 00:00:00 2001 From: eikendev Date: Tue, 15 Feb 2022 22:40:40 +0100 Subject: [PATCH] Move FAQ to the bottom --- README.md | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 1dc21fb..63a9e66 100644 --- a/README.md +++ b/README.md @@ -31,21 +31,7 @@ It enables you to send notifications via a simple web API, and delivers them to This is similar to what [Pushover](https://pushover.net/) and [Gotify](https://gotify.net/) offer, but it does not require an additional app. The vision is to have compatibility with Gotify on the sending side, while on the receiving side an established service is used. -This has the advantages that -- sending plugins written for Gotify (like those for [Watchtower](https://containrrr.dev/watchtower/) and [Jellyfin](https://jellyfin.org/)) as well as -- receiving clients written for Matrix -can be reused. - -### Why Matrix instead of X? - -This project totally would've used Signal if it would offer a proper API. -Sadly, neither [Signal](https://signal.org/) nor [WhatsApp](https://www.whatsapp.com/) come with an API (at the time of writing) through which PushBits could interact. - -In [Telegram](https://telegram.org/) there is an API to run bots, but these are limited in that they cannot create chats by themselves. -If you insist on going with Telegram, have a look at [webhook2telegram](https://github.com/muety/webhook2telegram). - -The idea of a federated, synchronized but yet end-to-end encrypted protocol is awesome, but its clients simply aren't really there yet. -Still, if you haven't tried it yet, we'd encourage you to check it out. +This has the advantages that we need to maintain neither plugins (like those for [Watchtower](https://containrrr.dev/watchtower/) and [Jellyfin](https://jellyfin.org/)) nor clients. ## 🤘 Features @@ -79,3 +65,16 @@ Before moving forward, please refer to [out contribution guidelines](CONTRIBUTIN Check [this document](SECURITY.md) for information on how you can bring it to our attention. :star: **Like fancy graphs?** See [our stargazers over time](https://starchart.cc/pushbits/server). + +## ❓ Frequently Asked Questions (FAQ) + +### Why Matrix instead of X? + +This project totally would've used Signal if it would offer a proper API. +Sadly, neither [Signal](https://signal.org/) nor [WhatsApp](https://www.whatsapp.com/) come with an API (at the time of writing) through which PushBits could interact. + +In [Telegram](https://telegram.org/) there is an API to run bots, but these are limited in that they cannot create chats by themselves. +If you insist on going with Telegram, have a look at [webhook2telegram](https://github.com/muety/webhook2telegram). + +The idea of a federated, synchronized but yet end-to-end encrypted protocol is awesome, but its clients simply aren't really there yet. +Still, if you haven't tried it yet, we'd encourage you to check it out.