From e6e6ee65c33e43fb59fca3d557d49e551138f6b7 Mon Sep 17 00:00:00 2001
From: yunohost-bot <yunohost@yunohost.org>
Date: Sun, 4 Sep 2022 22:43:04 +0000
Subject: [PATCH] Auto-update README

---
 README.md    | 26 ++++++++++++++------------
 README_fr.md | 12 ++++++------
 2 files changed, 20 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index b9a67c7..dfb6fe6 100644
--- a/README.md
+++ b/README.md
@@ -3,14 +3,14 @@ N.B.: This README was automatically generated by https://github.com/YunoHost/app
 It shall NOT be edited by hand.
 -->
 
-# Matrix WhatsApp bridge for YunoHost
+# Matrix-WhatsApp bridge for YunoHost
 
 [![Integration level](https://dash.yunohost.org/integration/mautrix_whatsapp.svg)](https://dash.yunohost.org/appci/app/mautrix_whatsapp) ![Working status](https://ci-apps.yunohost.org/ci/badges/mautrix_whatsapp.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/mautrix_whatsapp.maintain.svg)  
-[![Install Matrix WhatsApp bridge with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mautrix_whatsapp)
+[![Install Matrix-WhatsApp bridge with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mautrix_whatsapp)
 
 *[Lire ce readme en français.](./README_fr.md)*
 
-> *This package allows you to install Matrix WhatsApp bridge quickly and simply on a YunoHost server.
+> *This package allows you to install Matrix-WhatsApp bridge quickly and simply on a YunoHost server.
 If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
 
 ## Overview
@@ -28,14 +28,14 @@ Therefore, [Synapse for YunoHost](https://github.com/YunoHost-Apps/synapse_ynh)
 
 ## Disclaimers / important information
 
-### List of known public services
+## List of known public services
 
 * Ask on one of the following rooms: #mautrix_yunohost:matrix.fdn.fr or #whatsapp:maunium.net
 
-### Bridging usage
+## Bridging usage
 ** Note that several WhatsApp and Matrix users can be bridged, each WhatsApp account has its own bot administration room. If they are in a same WhatsApp group, only one matrix room will be created. **
 
-#### Bridge a WhatsApp user and a Matrix user
+### Bridge a WhatsApp user and a Matrix user
 * First your matrix user or server has to be authorized in the bridge configuration (see below)
 * Then, invite the bot (default @whatsappbot:yoursynapse.domain) 
 * The room with the Mautrix-WhatsApp bot is called "administration room".
@@ -44,7 +44,7 @@ Therefore, [Synapse for YunoHost](https://github.com/YunoHost-Apps/synapse_ynh)
 * Send ``help`` to the bot in the created room to know how to control the bot.
 See also [upstream wiki Authentication page](https://docs.mau.fi/bridges/go/whatsapp/authentication.html)
 
-#### Bridge an existing room | Bridge Whatsapp to Signal over Matrix
+### Bridge an existing room | Bridge Whatsapp to Signal over Matrix
 By default, the bridge creates a portal room for each WA group that the WA user actively uses.
 Your can also create a portal for an existing Matrix room. **Note that this can be a room created by another bridge, e.g. a Signal portal room**
 1. Invite the bridge bot to the room (with an authorized user)
@@ -53,7 +53,7 @@ Your can also create a portal for an existing Matrix room. **Note that this can
 4. Get the WA invite link `!wa invite-link` and share it with friends. Or invite Whatsapp puppets to room.
 5. Optional: Activate relaybot, see next section.
 
-#### Relaybot: Bridge a group for several Matrix and several WhatsApp users to chat together
+### Relaybot: Bridge a group for several Matrix and several WhatsApp users to chat together
 **When upgrading from <v0.2.0, the relaybot system changed. There is no relaybot administration room anymore. Relay must be re-activated in all rooms**. 
 
 To be able to bridge not only your logged in Matrix account but also Matrix friends you invite to a portal room, you need to:
@@ -65,14 +65,16 @@ To be able to bridge not only your logged in Matrix account but also Matrix frie
 * On the matrix side: the bridge will create matrix puppets corresponding to the WhatsApp users when they send a message.
 See also [upstream wiki Relaybot page](https://docs.mau.fi/bridges/general/relay-mode.html)
 
-### Configuration of the bridge
+## Configuration of the bridge
 
 The bridge is [roughly configured at installation](https://github.com/YunoHost-Apps/mautrix_whatsapp_ynh/blob/master/conf/config.yaml), e.g. allowed admin and user of the bot. Finer configuration can be done by modifying the
 following configuration file with SSH: 
 ```/opt/yunohost/mautrix_whatsapp/config.yaml```
 and then restarting the mautrix_whatsapp service.
 
-### Multi-users support
+## YunoHost specific features
+
+#### Multi-user support
 
 * Bot users are not related to Yunohost users. Any Matrix account or Synapse server autorized in the configuration of the bridge can invite/use the bot. 
 * The WhatsApp bot is a local Matrix-Synapse user, but accessible through federation (synapse public or private).
@@ -80,7 +82,7 @@ and then restarting the mautrix_whatsapp service.
 * If several bot users are in a same WhatsApp group, only one Matrix room will be created by the bridge.
 * See https://github.com/YunoHost-Apps/synapse_ynh#multi-users-support
 
-### Multi-instance support
+#### Multi-instance support
 
 * Multi-instance installation should work. Several bridge instances could be installed for one Matrix-Synapse instance so that one Matrix user can bridge several WhatsApp accounts. 
 * Several bridge instances could be installed for each Matrix-Synapse instance to benefit from it. But one bridge can be used by users from several Matrix-Synapse instances.
@@ -89,7 +91,7 @@ and then restarting the mautrix_whatsapp service.
 
 ARM, ARM64, AMD64
 
-### Limitations
+## Limitations
 
 * Audio/Video calls are not bridged yet. 
 * If WhatsApp loses connection, e.g. the phone is set in flight mode or push notifications are deactivated, the bot has sometimes to be restarted manually by sending a reconnnect message in the matrix administration room.
diff --git a/README_fr.md b/README_fr.md
index d2650e1..2a072a4 100644
--- a/README_fr.md
+++ b/README_fr.md
@@ -3,14 +3,14 @@ N.B.: This README was automatically generated by https://github.com/YunoHost/app
 It shall NOT be edited by hand.
 -->
 
-# Matrix WhatsApp bridge pour YunoHost
+# Matrix-WhatsApp bridge pour YunoHost
 
 [![Niveau d'intégration](https://dash.yunohost.org/integration/mautrix_whatsapp.svg)](https://dash.yunohost.org/appci/app/mautrix_whatsapp) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/mautrix_whatsapp.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/mautrix_whatsapp.maintain.svg)  
-[![Installer Matrix WhatsApp bridge avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mautrix_whatsapp)
+[![Installer Matrix-WhatsApp bridge avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mautrix_whatsapp)
 
 *[Read this readme in english.](./README.md)*
 
-> *Ce package vous permet d'installer Matrix WhatsApp bridge rapidement et simplement sur un serveur YunoHost.
+> *Ce package vous permet d'installer Matrix-WhatsApp bridge rapidement et simplement sur un serveur YunoHost.
 Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
 
 ## Vue d'ensemble
@@ -28,14 +28,14 @@ C'est pourquoi [Synapse for YunoHost](https://github.com/YunoHost-Apps/synapse_y
 
 ## Avertissements / informations importantes
 
-### Liste de passerelles publiques
+## Liste de passerelles publiques
 
 * Demandez sur un des salons suivants: #mautrix_yunohost:matrix.fdn.fr or #whatsapp:maunium.net
 
-### Usages de la passerelle
+## Usages de la passerelle
 ** Notez que plusieurs comptes WhatsApp et Matrix peuvent être relayés, chaque compte WhatsApp connecté a son propre Salon d'Administration. Si plusieurs utilisateur.ice.s du Robot sont dans un même groupe WhatsApp, seul un Salon Matrix sera créé par la passerelle. **
 
-#### Relayer TOUTES les conversations entre UN compte WhatsApp et UN compte Matrix
+### Relayer TOUTES les conversations entre UN compte WhatsApp et UN compte Matrix
 * Prérequis : votre compte Matrix ou le serveur sur lequel il est hébergé doit être autorisé dans la configuration de la passerelle (voir ci-dessous)
 * Invitez le Robot (par défaut @whatsappbot:synapse.votredomaine) à une nouvelle conversation.
 * Ce nouveau salon d'administration du Robot Mautrix-WhatsApp est appelé "Administration Room".