From d5ff4ae60a9436cf5094cba051803898a02cfbec Mon Sep 17 00:00:00 2001 From: leinher <53341108+leinher@users.noreply.github.com> Date: Fri, 9 Jun 2023 13:42:14 +0200 Subject: [PATCH 1/2] Document the verification process of a new WeeChat client The /help olm page only provides the available commands. The help page does not present a workflow to use the commands. This commit adds a short step by step guide to get new user started after installing. --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index fb0fd79..cb6dac2 100644 --- a/README.md +++ b/README.md @@ -327,3 +327,19 @@ name conflicts from causing logger file conflicts. device verification. `/matrix help [command]` will print information for subcommands, such as `/matrix help server` + +# Verify your Weechat-Matrix-Client + +To verify your Weechat-Matrix-Client the following steps are required. + +| Verified client (e.g) Element | Weechat client | +| ----------------------------- | -------------- | +| | run `/olm start ` | +| accept the incomming verification request | | +| compare the emojis | compare the emojis | +| confirm if emojis match | run `/olm confirm ` | + +Now your Weechat-Matrix-Client is a verified device. + +To chat you need to verify all previously used devices of your accounts. +Run `/olm verify ` to do that. From 2d408ca84a070ede914c94082d7e86d333485fa7 Mon Sep 17 00:00:00 2001 From: Hermann Leinweber <53341108+leinher@users.noreply.github.com> Date: Thu, 20 Jul 2023 15:14:29 +0200 Subject: [PATCH 2/2] Update README.md review fix Co-authored-by: Marco Trevisan --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cb6dac2..631ce77 100644 --- a/README.md +++ b/README.md @@ -334,7 +334,7 @@ To verify your Weechat-Matrix-Client the following steps are required. | Verified client (e.g) Element | Weechat client | | ----------------------------- | -------------- | -| | run `/olm start ` | +| | run `/olm verification start ` | | accept the incomming verification request | | | compare the emojis | compare the emojis | | confirm if emojis match | run `/olm confirm ` |