From 33efe80c21e1a0e520b7bbe073ebc604926e37b5 Mon Sep 17 00:00:00 2001
From: Dawid Rejowski <dawid@rejowski.xyz>
Date: Sun, 11 Sep 2022 22:38:20 +0200
Subject: [PATCH] Add README.md

---
 README.md            | 31 +++++++++++++++++++++++++++++++
 config.yaml.example  | 19 +++++++++++--------
 telegram_exporter.py |  7 -------
 3 files changed, 42 insertions(+), 15 deletions(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8684077
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Telegram -> Matrix stickerpack importer
+
+This bot allows for simple and quick copying Telegram stickers into Matrix rooms.
+Stickers can be used in clients that implemented them natively by Matrix
+([msc2545](https://github.com/matrix-org/matrix-spec-proposals/pull/2545))
+like [FluffyChat](https://fluffychat.im/), [Nheko](https://nheko-reborn.github.io/) and [Cinny](https://cinny.in/).
+Element currently **does not** support native stickers (can only display them when send by others).
+
+## Requirements
+- Python 3.9+ and pip
+- Matrix account dedicated for the bot
+- Telegram API keys and bot token (**Please don't share it with anyone**)
+
+## Instalation
+- Create **new** Matrix account dedicated for the bot
+- Get Telegram API key and API hash from https://my.telegram.org/apps
+- Create new Telegram bot and get bot token by talking to https://t.me/botfather
+- Clone this repository and install dependencies
+```
+git clone https://codeberg.org/ghostermonster/stickerbridge 
+cd stickerbridge
+pip install -r requirements.txt
+```
+- Copy example config file ```cp config.yaml.example config.yaml```
+- Fill the config file with creditials for Matrix account and Telegram bot you created
+- Run the bot ```python main.py```
+
+## Usage
+Invite the bot in a room (currently does not support encrypted rooms), type ```!sb help``` to list available commands.
+Type ```import <stickerpack name>``` to import stickerpack to the room, ex. ```import bestblobcats```.
+After importing is completed, you will see stickerpack in the menu.
diff --git a/config.yaml.example b/config.yaml.example
index 02f8fd0..fc37df4 100644
--- a/config.yaml.example
+++ b/config.yaml.example
@@ -1,13 +1,16 @@
-command_prefix: "!sb"
-
-matrix_homeserver: "https://matrix.org"
-matrix_username: "@username:example.com"
-matrix_password: "password"
-
-matrix_bot_name: "Telegram stickers bot"
-
+# api_id and api_hash can be obtained from https://my.telegram.org/apps
+# bot token can be obtained by talking to https://t.me/botfather
 telegram_api_id: 1234567
 telegram_api_hash: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
 telegram_bot_token: "1234567890:aaaaaaaaaaaaaaaaaaaaaa--aaaaaaaaaaa"
 
+# Creditials for the Matrix account to being used by the bot
+# Please use dedicated, freshly created one
+matrix_homeserver: "https://matrix.org"
+matrix_username: "@username:matrix.org"
+matrix_password: "password"
+
+command_prefix: "!sb"
+matrix_bot_name: "Telegram stickers bot"
+
 log_level: INFO
diff --git a/telegram_exporter.py b/telegram_exporter.py
index c61c6e9..08eaaa8 100644
--- a/telegram_exporter.py
+++ b/telegram_exporter.py
@@ -49,13 +49,6 @@ def _convert_animation(data: bytes, width=256, height=0):
 
 class TelegramExporter:
     def __init__(self, api_id: int, api_hash: str, bot_token: str, secrets_filename: str):
-        """Exports Telegram stickers as images.
-
-        :param api_id: Can be obtained at https://my.telegram.org/apps
-        :param api_hash: Can be obtained at https://my.telegram.org/apps
-        :param bot_token: Required to get stickers, can be obtained by talking to https://t.me/botfather
-        :param secrets_filename: Session name, it would be filename of stored creditials
-        """
         self.api_id = api_id
         self.api_hash = api_hash
         self.bot_token = bot_token