diff --git a/README.md b/README.md index b946a934..959bbfbf 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,19 @@ A Matrix-Telegram hybrid puppeting/relaybot bridge. ## Sponsors * [Joel Lehtonen / Zouppen](https://github.com/zouppen) -### [Wiki](https://github.com/tulir/mautrix-telegram/wiki) +### Wiki +All setup and usage instructions are located in the GitHub +[wiki](https://github.com/tulir/mautrix-telegram/wiki). Some quick links: -### [Features & Roadmap](https://github.com/tulir/mautrix-telegram/blob/master/ROADMAP.md) +* [Bridge setup](https://github.com/tulir/mautrix-telegram/wiki/Bridge-setup) + (or [with Docker](https://github.com/tulir/mautrix-telegram/wiki/Bridge-setup-with-Docker)) +* Basic usage: [Authentication](https://github.com/tulir/mautrix-telegram/wiki/Authentication), + [Creating chats](https://github.com/tulir/mautrix-telegram/wiki/Creating-and-managing-chats), + [Relaybot setup](https://github.com/tulir/mautrix-telegram/wiki/Relay-bot) + +### Features & Roadmap +[ROADMAP.md](https://github.com/tulir/mautrix-telegram/blob/master/ROADMAP.md) +contains a general overview of what is supported by the bridge. ## Discussion Matrix room: [`#telegram:maunium.net`](https://matrix.to/#/#telegram:maunium.net) @@ -20,4 +30,4 @@ Matrix room: [`#telegram:maunium.net`](https://matrix.to/#/#telegram:maunium.net Telegram chat: [`mautrix_telegram`](https://t.me/mautrix_telegram) (bridged to Matrix room) ## Preview -![Preview](https://raw.githubusercontent.com/tulir/mautrix-telegram/master/preview.png) +![Preview](preview.png) diff --git a/preview.png b/preview.png index 1859d93a..c0d35f72 100644 Binary files a/preview.png and b/preview.png differ