mautrix-telegram/README.md

# mautrix-telegram
![Languages](https://img.shields.io/github/languages/top/mautrix/telegramgo.svg)
[![License](https://img.shields.io/github/license/mautrix/telegramgo.svg)](LICENSE)
[![Release](https://img.shields.io/github/release/mautrix/telegramgo/all.svg)](https://github.com/mautrix/telegramgo/releases)
[![GitLab CI](https://mau.dev/mautrix/telegramgo/badges/master/pipeline.svg)](https://mau.dev/mautrix/telegramgo/container_registry)

A Matrix-Telegram hybrid puppeting/relaybot bridge.

## Sponsors
* [Joel Lehtonen / Zouppen](https://github.com/zouppen)

## Documentation
The rewrite doesn't exist yet, so there's no documentation.

<!--
All setup and usage instructions are located on
[docs.mau.fi](https://docs.mau.fi/bridges/go/telegram/index.html).
Some quick links:

* [Bridge setup](https://docs.mau.fi/bridges/go/setup.html?bridge=telegramgo)
  (or [with Docker](https://docs.mau.fi/bridges/general/docker-setup.html?bridge=telegramgo))
* Basic usage: [Authentication](https://docs.mau.fi/bridges/go/telegram/authentication.html),
  [Creating chats](https://docs.mau.fi/bridges/go/telegram/creating-and-managing-chats.html),
  [Relaybot setup](https://docs.mau.fi/bridges/go/telegram/relay-bot.html)
-->

### Features & Roadmap
[ROADMAP.md](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)

Telegram chat: [`mautrix_telegram`](https://t.me/mautrix_telegram) (bridged to Matrix room)

## Preview
![Preview](preview.png)