From 8bbcd3c851221189ad74da9c8b51415a525b7417 Mon Sep 17 00:00:00 2001 From: John Livingston Date: Tue, 20 Jul 2021 10:40:58 +0200 Subject: [PATCH] Ref to changelog. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a56a1002..29baf2be 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,10 @@ This plugin is meant to provide web chat for Peertube videos. -The plugin has to rely on an external tool as web chat backend. There are multiple ways to provide such functionality: - **For release notes and breaking changes list, please see the [CHANGELOG](CHANGELOG.md) before updating the plugin.** +The plugin has to rely on an external tool as web chat backend. There are multiple ways to provide such functionality: + * **Prosody server controlled by Peertube (recommended):** this plugin can launch a [Prosody](https://prosody.im) process and auto-configure it. [Documentation](documentation/prosody.md). **This is the recommanded setup, and is almost automatic to setup**. * **Connect to an existing XMPP server with ConverseJS:** you can use an external Jabber/XMPP server. This server has to provide BOSH or Websocket API, accept anonymous loggin, and accept room creation. [Documentation](documentation/conversejs.md) * **Use an external web chat tool:** you can use any external web chat tool, that can be included in an iframe. [Documentation](documentation/external.md)