From 367083d6ff02070a3b3a592699d1935d8a71675b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Thu, 28 Mar 2019 17:07:10 +0100 Subject: [PATCH] README: Add instalation and usage instructions. --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 8c128d5..587c451 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,27 @@ pantalaimon A E2E aware matrix proxy daemon. This still in an early development phase. + +Instalation +=========== + +The [Olm](https://git.matrix.org/git/olm/) C library is required to be installed +before installing pantalaimon. + +Instalation works like usually with python packages: + + python setup.py install + +Usage +===== + +Running the daemon is relatively easy: + + pantalaimon https://example.org:443 + +After running the daemon configure your client to connect to the daemon instead +of your homeserver. The daemon listens by default on localhost and port 8009. + +The listening address and port can be configured: + + pantalaimon -l 127.0.0.1 -p 8008 https://example.org:8008