Elm library: beta version of the Elm SDK

Go to file

Bram 5ac3e7eb6a Fix Event test This commit is starting to show how the definition of the Envelope wrapper is better done on a different level		2023-12-24 00:37:22 +01:00
docs	Add guidelines to merging branches	2023-12-16 01:49:13 +01:00
src	Fix Event test	2023-12-24 00:37:22 +01:00
tests	Fix Event test	2023-12-24 00:37:22 +01:00
.gitignore	Add VSCode workspace settings to .gitignore	2023-12-18 01:34:00 +01:00
LICENSE	Final changes before v1.0.0	2023-12-14 11:21:49 +01:00
README.md	Fix broken link	2023-12-18 01:57:14 +01:00
elm.json	Add exposed Event module	2023-12-24 00:03:07 +01:00

README.md

Matrix SDK (beta version)

The Matrix SDK in Elm allows users to communicate with other instances using the Matrix protocol.

The Elm SDK serves as a more consistent alternative to the matrix-js-sdk, which is a JavaScript implementation of the Matrix protocol with several downsides. In contrast, the Elm SDK supports:

✅ Matrix spec version adjustment based on which spec version the homeserver supports. The matrix-js-sdk spec uses endpoints from legacy versions and exclusively supports the latest 4 spec versions, while this SDK listens to the homeserver's supported spec versions and talks to the server accordingly. See docs/supported.md to discover which interactions are supported for which spec versions.
✅ One way to do things instead of having multiple functions that are considered deprecated.

How to install

In your terminal, run

elm install noordstar/elm-matrix-sdk-beta

Keep in mind that the beta versions are intended to develop rapidly. You should not expect the versions to remain reliable for years! If you need a stable version, please wait around for a full version.

Contribute

If you wish to contribute, please read the contribution guide.