From 0a2a549fb4788298222968be25f71ec0534f571d Mon Sep 17 00:00:00 2001 From: Simon Roy <49426163+PenguinBoi12@users.noreply.github.com> Date: Tue, 10 Mar 2026 02:35:14 -0400 Subject: [PATCH] Update README.md for clarity and links --- README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index fc1c669..7a086a5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -

Matrix.py

-
A simple, developer-friendly library to create powerful Matrix bots.
@@ -9,13 +7,14 @@
[![Static Badge](https://img.shields.io/badge/%F0%9F%93%9A-Documentation-%235c5c5c)](https://github.com/Code-Society-Lab/matrixpy/wiki) -[![Join on Discord](https://discordapp.com/api/guilds/823178343943897088/widget.png?style=shield)](https://discord.gg/code-society-823178343943897088) +[![Join Discord](https://discordapp.com/api/guilds/823178343943897088/widget.png?style=shield)](https://discord.gg/code-society-823178343943897088) +[![Join Matrix](https://img.shields.io/matrix/codesociety%3Amatrix.org?logo=matrix&label=%20&labelColor=%23202020&color=%23202020)](https://matrix.to/#/%23codesociety:matrix.org ) [![Tests](https://github.com/Code-Society-Lab/matrixpy/actions/workflows/tests.yml/badge.svg)](https://github.com/Code-Society-Lab/matrixpy/actions/workflows/tests.yml) [![CodeQL Advanced](https://github.com/Code-Society-Lab/matrixpy/actions/workflows/codeql.yml/badge.svg)](https://github.com/Code-Society-Lab/matrixpy/actions/workflows/codeql.yml) [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/Code-Society-Lab/matrixpy/badge)](https://securityscorecards.dev/viewer/?uri=github.com/Code-Society-Lab/matrixpy) Matrix.py is a lightweight and intuitive Python library to build bots on -the [Matrix protocol]([Matrix](https://matrix.org)). It provides a clean, +the [Matrix protocol](https://matrix.org). It provides a clean, decorator-based API similar to popular event-driven frameworks, allowing developers to focus on behavior rather than boilerplate. @@ -37,7 +36,7 @@ pip install matrix-python If you plan on contributing to matrix.py, we recommend to install the development libraries: ``` -pip install .[env] +pip install -e .[dev] ``` *Note*: It is recommended to use a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/) when installing python packages. @@ -46,19 +45,18 @@ pip install .[env] ```python from matrix import Bot, Context -bot = Bot(username="@gracehopper:matrix.org", password="grace1234") +bot = Bot(config="config.yml") @bot.command("ping") async def ping(ctx: Context): - print(f"{ctx.sender} invoked {ctx.body} in room {ctx.room_name}.") await ctx.send("Pong!") bot.start() ``` -[Documentation](https://github.com/Code-Society-Lab/matrixpy/wiki) - [Examples]([https://github.com/Code-Society-Lab/matrixpy/wiki](https://github.com/Code-Society-Lab/matrixpy/tree/main/examples)) +[Documentation](https://github.com/Code-Society-Lab/matrixpy/wiki) - [Examples](https://github.com/Code-Society-Lab/matrixpy/tree/main/examples) # Contributing We welcome everyone to contribute! @@ -66,7 +64,7 @@ We welcome everyone to contribute! Whether it's fixing bugs, suggesting features, or improving the docs - every bit helps. - Submit an issue - Open a pull request -- Or just hop into our [Discord community](https://discord.gg/code-society-823178343943897088) and say hi! +- Or just hop into our [Matrix](https://matrix.to/#/%23codesociety:matrix.org) or [Discord](https://discord.gg/code-society-823178343943897088) server and say hi! If you intend to contribute, please read the [CONTRIBUTING.md](./CONTRIBUTING.md) first. Additionally, **every contributor** is expected to follow the [code of conduct](./CODE_OF_CONDUCT.md).