From 014fab7b276b48651ba097af403e33a45bdf9e6a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maxime=20=E2=80=9Cpep=E2=80=9D=20Buquet?= Date: Sun, 16 Feb 2020 16:34:41 +0100 Subject: [PATCH] README: Add note about experimental state, recommend master MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Maxime “pep” Buquet --- README.rst | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index 2069994..411d58a 100644 --- a/README.rst +++ b/README.rst @@ -6,16 +6,9 @@ distributed separately for licensing reasons. This plugin is very much **alpha**. It handles encryption and decryption of OMEMO messages, but doesn't display the encryption state of messages, -and neither does it have a way to do trust management. - -Use in poezio -------------- - -Once installed (see the `Installation`_ section below), you can add -`omemo` in the `plugin_autoload` configuration. See the Poezio -`documentation -`_ for more -information about autoloading plugins. +and neither does it have a way to do trust management. As this plugin is +still changing often, it is recommended that users follow experimental +(master) versions of this project and its dependencies. License ------- @@ -35,8 +28,21 @@ Please take this into consideration when using this library. Installation ------------ +As this plugin is still changing often, it is recommended that users +follow experimental (master) versions of this project and its +dependencies. + - ArchLinux (AUR): `python-poezio-omemo `_, or `python-poezio-omemo-git `_ - PIP: `poezio-omemo` - Manual: `python3 setup.py install` + +Use in poezio +------------- + +Once installed (see the `Installation`_ section below), you can add +`omemo` in the `plugin_autoload` configuration. See the Poezio +`documentation +`_ for more +information about autoloading plugins.