patch e1a17b912b5984786b1fe73f14faa785efe8920e Author: E. Bosch Date: Wed Feb 23 20:32:39 CET 2022 * Update README diff -rN -u old-irgramd/README.md new-irgramd/README.md --- old-irgramd/README.md 2024-11-22 21:37:59.586659792 +0100 +++ new-irgramd/README.md 2024-11-22 21:37:59.586659792 +0100 @@ -1,13 +1,37 @@ # irgramd - IRC <-> Telegram Gateway irgramd is a gateway that allows connecting from an [IRC] client to -[Telegram] as a regular user (not bot) +[Telegram] as a regular user (not bot). irgramd is written in [python] (version 3), it acts as an IRC server where an IRC client can connect and on the other side it's a Telegram client -using the [Telethon] library +using the [Telethon] library. -**[ This is a fork from [pbui/irtelegramd] to resume the development ]** +**[irgramd primary repository] is in [darcs] version control system, [github +repository] is synched as secondary** + +**irgramd is a fork from [pbui/irtelegramd] to resume the development** + +**irgramd is under active development in alpha state, several planned features +are not implemented yet** + +## How it works + +Configure your IRC client to connect to irgramd (running on the same host or +on a remote host) then you will see in your IRC client the Telegram groups +as IRC channels and Telegram users as IRC users, if you send a message to a +user or channel in IRC it will go to the corresponding user or group in +Telegram, and the same from Telegram to IRC. + +The users on Telegram using the official or other clients will see you with +your regular Telegram user account and will be indistinguishable for them +whether you are using irgramd or another Telegram client. + +Several IRC clients can connect to irgramd but they will see the same +Telegram account, this allows connecting to the same Telegram account from +different IRC clients on different locations or devices, so one irgramd +instance only connects to one Telegram account, if you want to connect to +several Telegram accounts you will need to run several irgramd instances. ## License @@ -21,4 +45,7 @@ [Telegram]: https://telegram.org/ [python]: https://www.python.org/ [Telethon]: https://github.com/LonamiWebs/Telethon +[irgramd primary repository]: https://src.presi.org/darcs/irgramd +[darcs]: http://darcs.net +[github repository]: https://github.com/prsai/irgramd [pbui/irtelegramd]: https://github.com/pbui/irtelegramd