commit ccb3665fc01e403fba328310a709030a44fbddf8 parent b53809b1755bdb36832f5d460dbaebcaaabb874b Author: bsandro <email@bsandro.tech> Date: Thu, 24 Aug 2023 22:56:35 +0300 Fixed readme Diffstat:
| A | README | | | 38 | ++++++++++++++++++++++++++++++++++++++ |
| D | readme.txt | | | 12 | ------------ |
2 files changed, 38 insertions(+), 12 deletions(-)
diff --git a/README b/README @@ -0,0 +1,38 @@ +What is this +------------ + +Simple bot that logs messages from public/private channels it have been added to. + +How to set up +------------- + +There is a special Telegram bot named @BotFather - send it a message '/newbot' (without quotes) and follow provided instructions. BotFather will grant you a token - put it inside the 'config.ini' so the file looks like this: + +token = 123123:bunchofletters + +Then you have to permit your bot to access messages in public channels - again send @BotFather a message '/setprivacy' (without quotes) and choose "Disable" option after a selector appears. + +After that bot can be added to public channels. + +How to run +---------- + +After setting it all up just run the executable ('leobot' or 'leobot.exe'). + +Logfiles location +----------------- + +Logs are being written into the "logs" folder placed in the same directory where your bot executable is. Folder structure is "channel/year/month/day/log.txt" + +Building from source +-------------------- + +This is a primitive Go project, min. golang version is 1.18 +External dependencies are bundled inside of the 'vendor' directory (go-ini and go-telegram-bot-api). + +Simply run 'go build' in the root directory to build. + +License +------- + +BSD 2-clause. diff --git a/readme.txt b/readme.txt @@ -1,12 +0,0 @@ -Simple bot for logging messages from public channels that it have been added to and private ones. - -How to run? - -There is a special bot @BotFather in Telegram - message /newbot to it and follow instructions. It will provide a oken for the bot - put it inside the config.ini file so it looks like: -token = 123123:bunchofletters - -Then you have to permit your bot to access messages in public channels - send @BotFather the command /setprivacy and choose "Disable" after a selector appears. - -Bot can be added to public chats afterwards. - -Logs are being written into the "logs" folder placed the same directory where your bot executable is. Folder structure is "channel/year/month/day/log.txt"