summary refs log tree commit diff
path: root/vendor/maunium.net/go/mautrix/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/maunium.net/go/mautrix/README.md')
-rw-r--r--vendor/maunium.net/go/mautrix/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/vendor/maunium.net/go/mautrix/README.md b/vendor/maunium.net/go/mautrix/README.md
new file mode 100644
index 0000000..ac41ca7
--- /dev/null
+++ b/vendor/maunium.net/go/mautrix/README.md
@@ -0,0 +1,22 @@
+# mautrix-go
+[![GoDoc](https://pkg.go.dev/badge/maunium.net/go/mautrix)](https://pkg.go.dev/maunium.net/go/mautrix)
+
+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/mautrix/whatsapp)
+and others.
+
+Matrix room: [`#go:maunium.net`](https://matrix.to/#/#go: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)
+* High-level module for building puppeting bridges
+* High-level module for building chat clients
+* Wrapper functions for the Synapse admin API
+* Structs for parsing event content
+* Helpers for parsing and generating Matrix HTML
+* Helpers for handling push rules