From e9d727c3a5309b53a87e3ffb41c4b8cc7037b815 Mon Sep 17 00:00:00 2001
From: Xubin Ren <xubinrencs@gmail.com>
Date: Fri, 17 Apr 2026 08:03:09 +0000
Subject: [PATCH] docs(readme): flag Matrix channel as unsupported on Windows
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

#3194 adds `; sys_platform != 'win32'` markers to `matrix-nio[e2e]` so
`pip install nanobot-ai[matrix]` no longer fails on Windows — but it also
no longer installs matrix-nio there. Without this note, Windows users get
a silent half-install and discover the limitation only when the channel
crashes at startup.

Made-with: Cursor
---
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/README.md b/README.md
index 37713842..140846ac 100644
--- a/README.md
+++ b/README.md
@@ -442,6 +442,13 @@ Install Matrix dependencies first:
 pip install nanobot-ai[matrix]
 ```
 
+> [!NOTE]
+> Matrix is not supported on Windows. `matrix-nio[e2e]` depends on
+> `python-olm`, which has no pre-built Windows wheel and is skipped by the
+> `matrix` extra on `sys_platform == 'win32'`. The command above will still
+> succeed on Windows but without `matrix-nio` installed, so enabling the
+> Matrix channel will fail at startup. Use macOS, Linux, or WSL2.
+
 **1. Create/choose a Matrix account**
 
 - Create or reuse a Matrix account on your homeserver (for example `matrix.org`).