diff --git a/README.md b/README.md index b4fa54e..54477ec 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,41 @@ # TelegramPoster -This bot is used for one and only task - post pictures from my personal archive. \ No newline at end of file +This bot is used for one and only task - post pictures from my personal archive. + +## Installation +To make this bot run at first you need to have a Python interpreter and git. Google is your friend finding it. You can also ignore git and simply download source code, should also work fine. After that you're ready to go. + +1. Download the bot. + 1. `git clone https://git.end-play.xyz/profitroll/TelegramSender.git` (if you want to use git) + 2. `cd ./TelegramSender` + +2. Install dependencies: + `python -m pip install -r requirements.txt` + Without installing those - bot cannot work at all + +3. Install optional dependencies [Not required]: + `python -m pip install -r requirements-optional.txt` + These are not required but can make the bot run a bit faster + +4. Configure your bot with a favorite text editor: + `nano config.json` + You can edit with vim, nano, on Windows it's Notepad or Notepad++. Whatever. + If you don't know where to find bot_token and your id - here you can find some hints: [get bot token](https://www.siteguarding.com/en/how-to-get-telegram-bot-api-token), [get your id](https://www.alphr.com/telegram-find-user-id/), [get api_hash and api_id](https://core.telegram.org/api/obtaining_api_id). + +5. Add bot to the channel + To use your bot of course you need to have a channel or group otherwise makes no sense to have such a bot. [Here](https://stackoverflow.com/a/33497769) you can find a quick guide how to add your bot to a channel. + +6. Fill your contents folder + Of course bot cannot post something from nothing. Configure your `config.json` what media types bot should post (`"posting", "extensions"`), when to post them (`"posting", "time"`) and also where to find them (`"locations"`). You can also move them when sent by setting `"posting", "move_sent"` to `true`. + +6. Good to go, run it! + `python ./main.py` + +## Command line arguments +Of course bot also has them. You can perform some actions with them. +* `--move-sent` - allows you to move all sent files from queue to sent directories +* `--cleanup` - purge files in both `queue` and `sent` folders if they're sent. Requires `--confirm` argument +* `--norun` - allows you to execute above arguments without tiggering the bot start itself + +Examples: +* `python3 ./main.py --move-sent --norun` +* `python3 ./main.py --cleanup --confirm` \ No newline at end of file