README: Add note about experimental state, recommend master
Signed-off-by: Maxime “pep” Buquet <pep@bouah.net>
This commit is contained in:
parent
88540420b4
commit
014fab7b27
1 changed files with 16 additions and 10 deletions
26
README.rst
26
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
|
||||
<https://doc.poez.io/plugins/index.html#plugin-autoload>`_ 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 <https://aur.archlinux.org/packages/python-poezio-omemo>`_, or
|
||||
`python-poezio-omemo-git <https://aur.archlinux.org/packages/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
|
||||
<https://doc.poez.io/plugins/index.html#plugin-autoload>`_ for more
|
||||
information about autoloading plugins.
|
||||
|
|
Loading…
Reference in a new issue