Elm library: beta version of the Elm SDK
Go to file
BramvdnHeuvel 17a1d1af3e
Publish beta 3.3.1
Merge pull request #29 from noordstar/develop
2024-06-10 10:10:41 +02:00
docs Add Elm SDK logo 2024-05-25 19:48:29 +02:00
src Prepare develop for master 2024-06-05 17:41:11 +02:00
tests/Test Prepare develop for master 2024-05-30 23:15:40 +02:00
.gitignore SECURITY: Remove Elm output 2024-05-30 14:02:20 +02:00
LICENSE Final changes before v1.0.0 2023-12-14 11:21:49 +01:00
README.md Add Matrix Room to README 2024-06-10 10:07:44 +02:00
elm.json Prepare develop for master 2024-06-05 17:41:11 +02:00


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 or join the conversation on Matrix 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.


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