write docs

1 files changed, 29 insertions, 0 deletions

diff --git a/README.md b/README.md
index 8bda91b..f2a5e97 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,30 @@
 # MatrixAppService
+
+Library that adds the Matrix Application Service API to Phoenix applications.
+
+## Installation
+
+Add this library to your dependencies in `mix.exs`
+
+```
+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
+* [ ] Bridge functionalities: relations between local and remote rooms
+* [ ] Bridge functionalities: handling of remote sessions
+* [ ] Conveniences for building bots