From b0713d0ddca66839b01a4aba09e0b16bea1e5feb Mon Sep 17 00:00:00 2001 From: Tulir Asokan Date: Tue, 15 Sep 2020 16:40:22 +0300 Subject: [PATCH] Update README.md --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 06e410e1..5a893ddf 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,23 @@ # mautrix-go [![GoDoc](https://godoc.org/maunium.net/go/mautrix?status.svg)](https://godoc.org/maunium.net/go/mautrix) -A Golang Matrix framework. +A Golang Matrix framework. Used by [gomuks](https://matrix.org/docs/projects/client/gomuks), +[go-neb](https://github.com/matrix-org/go-neb), [mautrix-whatsapp](https://github.com/tulir/mautrix-whatsapp) +and others. + +Matrix room: [`#maunium:maunium.net`](https://matrix.to/#/#maunium:maunium.net) This project is based on [matrix-org/gomatrix](https://github.com/matrix-org/gomatrix). The original project is licensed under [Apache 2.0](https://github.com/matrix-org/gomatrix/blob/master/LICENSE). +In addition to the basic client API features the original project has, this framework also has: + +* Appservice support (Intent API like mautrix-python, room state storage, etc) +* End-to-end encryption support (incl. interactive SAS verification) +* Structs for parsing event content +* Helpers for parsing and generating Matrix HTML +* Helpers for handling push rules + This project contains modules that are licensed under Apache 2.0: * [maunium.net/go/mautrix/crypto/canonicaljson](crypto/canonicaljson)