diff --git a/docs/telegram-usage.md b/docs/telegram-usage.md index c940f59ac..11eb831ad 100644 --- a/docs/telegram-usage.md +++ b/docs/telegram-usage.md @@ -87,6 +87,35 @@ Example configuration showing the different settings: }, ``` +## Create a custom keyboard (command shortcuts buttons) +Telegram allows us to create a custom keyboard with buttons for commands. +The default custom keyboard looks like this. +```python +[ + ['/daily', '/profit', '/balance'], # row 1, 3 commands + ['/status', '/status table', '/performance'], # row 2, 3 commands + ['/count', '/start', '/stop', '/help'] # row 3, 4 commands +] +``` +### Usage +You can create your own keyboard in `config.json`: +``` json +"telegram": { + "enabled": true, + "token": "your_telegram_token", + "chat_id": "your_telegram_chat_id", + "shortcut_btns": [ + ["/daily", "/stats", "/balance", "/profit"], + ["/status table", "/performance"], + ["/reload_config", "/count", "/logs"] + ] + }, +``` +!! NOTE: Only a certain list of commands are allowed. Command arguments are not +supported! +### Supported Commands + `/start`, `/stop`, `/status`, `/status table`, `/trades`, `/profit`, `/performance`, `/daily`, `/stats`, `/count`, `/locks`, `/balance`, `/stopbuy`, `/reload_config`, `/show_config`, `/logs`, `/whitelist`, `/blacklist`, `/edge`, `/help`, `/version` + ## Telegram commands Per default, the Telegram bot shows predefined commands. Some commands