path: root/README.md

# MatrixAppService

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

[![[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