Authentication may or may not now work

2017-11-13 01:19:12 +02:00
parent 9db90d2d5c
commit daeaca8c4f
13 changed files with 1100 additions and 121 deletions
@@ -1,4 +1,12 @@
 # mautrix-telegram
+**Not yet functional.**
+
 A Matrix-Telegram puppeting bridge.

-Not yet functional.
+## Usage
+1. Create a copy of `example-config.yaml` and fill out the fields.
+2. Generate the appservice registration with `./mautrix-telegram -g`.
+   You can use the `-c` and `-r` flags to change the location of the config and registration files.
+   They default to `config.yaml` and `registration.yaml` respectively.
+3. Run the bridge `./mautrix-telegram`. You can also use forever: `forever start mautrix-telegram`.
+4. Invite the appservice bot to a private room and view the commands with `!help`.