From 0b1aa650d805b4eb9054d5397540f8c5e1d01208 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Christian=20Gr=C3=BCnhage?= Date: Fri, 14 Feb 2020 02:38:46 +0100 Subject: [PATCH] Explain requirements for these modules --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 85783ee..dce54e0 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,11 @@ This repo contains a few ansible modules for working with matrix rooms. To install these modules so that you can use them, put them into `~/.ansible/plugins/modules/` or for global installation, install them to `/usr/share/ansible/plugins/modules/`. +## Requirements + + - **nio:** The modules require matrix-nio to be required on the target. Some bugs and missing features were found during the development of these modules, which have been fixed in the case of bugs and implemented in the case of missing features. Until they are merged upstream, you have to install the matrix-nio library from source using https://github.com/poljar/matrix-nio/pull/102. + - **Python >= 3.5:** The modules make extensive use of async/await, so only Python 3.5 or later are supported. These modules have only been tested with Python 3.8 so far. + ## Usage For a usage example including all modules, look at the example playbook below.