diff --git a/README.md b/README.md index f9b8c05..55b5d74 100644 --- a/README.md +++ b/README.md @@ -1 +1,42 @@ -# RoyaltyIT-tg-bot \ No newline at end of file +
+ +Этот бот создан специально для: [@RoyaltyProject](https://t.me/royaltyproject) + +### Установка: + +```shell +# Clone repository +$ git clone https://github.com/SantaSpeen/RoyaltyIT-tg-bot.git +# Change directory +$ cd src +# Install requirements +$ python3 -m pip install -r requirements.txt +# Create configuration file +# Then start the bot +$ python3 main.py +``` + +### config.json example + +```json +{ + "bot_token": "BOT_TOKEN", + "remote_chat": -1000, + "static_message": { + "start": { + "allow": "private", + "msg": "Привет, я бот \"Ял\".\nДля ознакомления с возможностями - /help" + }, + "help": { + "allow": "all", + "msg": "Помощь уже в пути!" + } + } +} +``` \ No newline at end of file