From fac5ef7f68827c35f95dc94d2d9a9234daf685af Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jan=20Christian=20Gr=C3=BCnhage?=
 <jan.christian@gruenhage.xyz>
Date: Fri, 14 Feb 2020 02:33:24 +0100
Subject: [PATCH] include example playbook in the README

---
 README.md | 42 +++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 41 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index fe1c363..85783ee 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,47 @@ To install these modules so that you can use them, put them into `~/.ansible/plu
 
 ## Usage
 
-For usage examples, look at the doc comments included in the source files for the modules.
+For a usage example including all modules, look at the example playbook below.
+```yaml
+- hosts: localhost
+  vars:
+    matrix:
+      homeserver: https://example.org
+      user: username
+      password: s3cr3t
+      alias: '#some-alias:example.org'
+      message: "Set room name in"
+  tasks:
+    - matrix-login:
+        hs_url: "{{ matrix.homeserver }}"
+        user_id: "{{ matrix.user }}"
+        password: "{{ matrix.password }}"
+      register: login_result
+    - matrix-room:
+        hs_url: "{{ matrix.homeserver }}"
+        token: "{{ login_result.token }}"
+        alias: "{{ matrix.alias }}"
+      register: room_result
+    - matrix-state:
+        hs_url: "{{ matrix.homeserver }}"
+        token: "{{ login_result.token }}"
+        room_id: "{{ room_result.room_id }}"
+        event_type: "m.room.name"
+        state_key: ""
+        content:
+          name: "test room name"
+      register: state_result
+    - matrix-notification:
+        hs_url: "{{ matrix.homeserver }}"
+        token: "{{ login_result.token }}"
+        room_id: "{{ room_result.room_id }}"
+        msg_plain: "{{ matrix.message }} {{ state_result.event_id}}"
+        msg_html: "{{ matrix.message }} {{ state_result.event_id}}"
+      when: state_result.changed
+    - matrix-logout:
+        hs_url: "{{ matrix.homeserver }}"
+        token: "{{ login_result.token }}"
+```
 
 ## Contributing
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.