From a4b501e305cfef086e2cf9b00a3187d934b61e7f Mon Sep 17 00:00:00 2001 From: John Livingston Date: Tue, 20 Jul 2021 10:40:07 +0200 Subject: [PATCH] Ref to changelog. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index bf55c4c8..a56a1002 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ 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.** + * **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)