From 2215b2937d028844f617de982efe04d25b3a493f Mon Sep 17 00:00:00 2001 From: lavadk Date: Mon, 17 May 2021 23:40:22 +0300 Subject: [PATCH] README extended, dependencies improved --- README.md | 29 +++++++++++++++++++++++++++-- requirements.txt | 2 +- requirements_test.txt | 2 +- 3 files changed, 29 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c62dee4..8f3cc7e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,27 @@ -# liker -Telegram bot that allows you to add reactions (likes, etc.) to channel posts + creates a separate button for comments +# Liker +Liker is a Telegram bot that allows you to add reactions (likes, etc.) to channel posts. Liker also supports post comments. + +## How to use Liker +You can either use an existing Liker bot available at https://t.me/liker10_bot. In order to do that: + +1. Give Liker bot an admin permission to edit posts in your channel. + +2. If you have a discussion group (e.g. post comments) — add Liker to the group also. + +3. In order to customize reactions (👍 is a default reaction) use command: +/set_reactions —channel_id [YOUR_CHANNEL_ID] —reactions [SPACE_SEPARATED_REACTIONS] +For example: +/set_reactions —channel_id @awesome_channel —reactions 👍 ❤ 😡 + +## Build liker from sources +To build your own version of Liker: + +1. Download the source code + +2. Create and customize data/config.json according to data/config_example.json + +3. To run with Docker use +``` +make build +make run-it +``` diff --git a/requirements.txt b/requirements.txt index 70d0379..4c4ccc2 100644 --- a/requirements.txt +++ b/requirements.txt @@ -11,5 +11,5 @@ requests==2.25.1 rsa==4.7.2 Telethon==1.21.1 typeguard==2.12.0 -urllib3==1.26.4 +urllib3>=1.26.4 tengi diff --git a/requirements_test.txt b/requirements_test.txt index 3a164d3..6374aec 100644 --- a/requirements_test.txt +++ b/requirements_test.txt @@ -16,5 +16,5 @@ python-jsonstore==1.3.0 requests==2.25.1 six==1.15.0 toml==0.10.2 -urllib3==1.26.3 +urllib3>=1.26.4 tengi