diff --git a/CHANGELOG.md b/CHANGELOG.md index a6b32da6..9828e2df 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,15 +1,15 @@ -# unreleased +# v26.04 (unreleased) * Rewrote bridge in Go using bridgev2 architecture. * To migrate the bridge, simply upgrade in-place. The database and config will be migrated automatically, although some parts of the config aren't - migrated (e.g. log config). + migrated (e.g. log config, permission types specific to the legacy bridge). * It is recommended to check the config file after upgrading. If you have prevented the bridge from writing to the config, you should update it manually. * The old-style relaybot is not yet supported and will not be migrated. Setups using the relaybot will have to manually log in as a bot and use - `set-relay` to enable the generic relay mode. + `set-relay` to enable the generic [relay mode](https://docs.mau.fi/bridges/general/relay-mode.html). # v0.15.3 (2025-07-16) diff --git a/README.md b/README.md index 8f936c0e..6243c43f 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,22 @@ # 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) +![Languages](https://img.shields.io/github/languages/top/mautrix/telegram.svg) +[![License](https://img.shields.io/github/license/mautrix/telegram.svg)](LICENSE) +[![Release](https://img.shields.io/github/release/mautrix/telegram/all.svg)](https://github.com/mautrix/telegram/releases) +[![GitLab CI](https://mau.dev/mautrix/telegram/badges/main/pipeline.svg)](https://mau.dev/mautrix/telegram/container_registry) -A Matrix-Telegram hybrid puppeting/relaybot bridge. +A Matrix-Telegram puppeting/relaybot bridge. ## Sponsors * [Joel Lehtonen / Zouppen](https://github.com/zouppen) ## Documentation -The rewrite doesn't exist yet, so there's no documentation. - - +* [Bridge setup](https://docs.mau.fi/bridges/go/setup.html?bridge=telegram) + (or [with Docker](https://docs.mau.fi/bridges/general/docker-setup.html?bridge=telegram)) +* Basic usage: [Authentication](https://docs.mau.fi/bridges/go/telegram/authentication.html) ### Features & Roadmap [ROADMAP.md](ROADMAP.md) contains a general overview of what is supported by the bridge.