summaryrefslogtreecommitdiff
path: root/README.md
blob: cee1edb3117fb0035b453a5d4568b241be1d3384 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# MatrixAppService

Library that adds the Matrix Application Service API to Phoenix applications.

## Hex packages

![[Hex.pm]](https://img.shields.io/hexpm/v/matrix_app_service?color=714a94)
https://hex.pm/packages/matrix_app_service/0.1.0

## Installation

Add this library to your dependencies in `mix.exs`

```elixir
defp deps do
  [...]
  {:matrix_app_service, "~> 0.1.0"}
end
```

## Usage

See [documentation](https://kazarma.gitlab.io/matrix_app_service.ex).

## Roadmap

* [x] Authorization
* [x] Router
* [x] User query
* [x] Room query
* [x] Transaction push
* [ ] Third party indications
* [ ] Allow usage of own Phoenix endpoint
* [ ] Bridge functionalities: relations between local and remote rooms
* [ ] Bridge functionalities: handling of remote sessions
* [ ] Conveniences for building bots