noordstar
/
elm-matrix-sdk-beta
mirror of https://github.com/noordstar/elm-matrix-sdk-beta
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Elm library: beta version of the Elm SDK
11 Commits
18 Branches
12 Tags
1.8 MiB
Elm 100%
 
Go to file
Bram van den Heuvel a53fca3326 Add VersionControl 2023-12-15 15:03:01 +01:00
docs Add documentation for v1.0.0 2023-12-14 11:18:20 +01:00
src Add VersionControl 2023-12-15 15:03:01 +01:00
.gitignore Initial commit 2023-12-07 21:17:12 +01:00
LICENSE Final changes before v1.0.0 2023-12-14 11:21:49 +01:00
README.md Add documentation for v1.0.0 2023-12-14 11:18:20 +01:00
elm.json Add VersionControl 2023-12-15 15:03:01 +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.

Follow us on Mastodon at @elm_matrix_sdk@social.noordstar.me to stay up-to-date on the latest changes.

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.