From e8f705d76fb5cb0a9bc63f08aacaa6e8eeb50f27 Mon Sep 17 00:00:00 2001 From: Ivan Enderlin Date: Mon, 7 Jul 2025 09:59:38 +0200 Subject: [PATCH] doc: Fix markup in `README.md` MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This patch fixes the markup in the `README.md` file. Links were broken because of the mix of HTML and Markdown. Plus, the HTML markup was kind of incorrect. Plus, too much `
`, most of them were “collapsed” automatically. Signed-off-by: Ivan Enderlin --- README.md | 51 +++++++++++++++++++++++++++------------------------ 1 file changed, 27 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index ba194daa7..62b932578 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,28 @@

Matrix Rust SDK

+
- Your all-in-one toolkit for creating Matrix clients with Rust, from simple bots to full-featured apps. -

- -
-
- - - - - - -
- - - - -
-
-
+ Your all-in-one toolkit for creating Matrix clients with Rust, from simple bots to full-featured apps. +
+ +
+ + + + + + +
+ + + +
+ The Matrix Rust SDK is a collection of libraries that make it easier to build [Matrix] clients in [Rust]. -

+
+
@@ -31,10 +30,13 @@ The Matrix Rust SDK is a collection of libraries that make it easier to build [M Element logo -

+
+
+ Development of the SDK is proudly sponsored and maintained by [Element](https://element.io). Element uses the SDK in their next-generation mobile apps Element X on [iOS](https://github.com/element-hq/element-x-ios) and [Android](https://github.com/element-hq/element-x-android) and has plans to introduce it to the web and desktop clients as well. The SDK is also the basis for multiple Matrix projects and we welcome contributions from all. +
## Purpose @@ -44,9 +46,6 @@ syncing, and room state, so you can focus on your app's logic and UI. Whether you're writing a small bot, a desktop client, or something in between, the SDK is designed to be flexible, async-friendly, and ready to use out of the box. -[Matrix]: https://matrix.org/ -[Rust]: https://www.rust-lang.org/ - ## Project structure The Matrix Rust SDK is made up of several crates that build on top of each other. Here are the key ones: @@ -81,3 +80,7 @@ into your language of choice. ## License [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) + + +[Matrix]: https://matrix.org/ +[Rust]: https://www.rust-lang.org/