2023-12-07 21:28:17 +00:00
|
|
|
# Matrix SDK (beta version)
|
|
|
|
|
|
|
|
|
|
The Matrix SDK in Elm allows users to communicate with other instances using
|
|
|
|
|
the [Matrix](https://matrix.org) protocol.
|
2023-12-14 10:18:20 +00:00
|
|
|
|
|
|
|
|
The Elm SDK serves as a more consistent alternative to the
|
|
|
|
|
[matrix-js-sdk](https://github.com/matrix-org/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](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](https://social.noordstar.me/@elm_matrix_sdk) at
|
|
|
|
|
@elm_matrix_sdk@social.noordstar.me to stay up-to-date on the latest changes.
|
|
|
|
|
|
|
|
|
|
## How to install
|
|
|
|
|
|
|
|
|
|
In your terminal, run
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
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.
|
2023-12-15 17:29:25 +00:00
|
|
|
|
|
|
|
|
## Contribute
|
|
|
|
|
|
|
|
|
|
If you wish to contribute, please read the
|
2023-12-18 00:57:14 +00:00
|
|
|
[contribution guide](docs/CONTRIBUTING.md).
|
