diff --git a/README.md b/README.md index 06f57d9..7a540be 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,21 @@ # KolabWopi *WARNING: PRE-ALPHA SOFTWARE, WILL EAT ALL THE BABIES* -KolabWopi provides an API implementing Web Application Open Interface standard. +KolabWopi provides a REST API implementing Web Application Open Interface. + +The goal of this project is to give document editing systems a way to +access Kolab storage. It will be achieved by proxying WOPI requests +into Kolab's Chwala service, which is the entry point to Kolab storage +and external file sources. + To learn about Kolab visit https://kolab.org +To learn about WOPI visit https://wopirest.readthedocs.io + + +To get started with KolabWopi: + + * Install dependencies with `mix deps.get` + * Start the application with `mix run --no-halt` + +Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.