diff --git a/README.md b/README.md index 78fc124..591af61 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # erfiume_bot Buy Me A Coffee [![Pulumi Up](https://github.com/notdodo/erfiume_bot/actions/workflows/pulumi-up.yml/badge.svg)](https://github.com/notdodo/erfiume_bot/actions/workflows/pulumi-up.yml) +[![Deploy Bot Lambda](https://github.com/notdodo/erfiume_bot/actions/workflows/bot-deploy.yml/badge.svg)](https://github.com/notdodo/erfiume_bot/actions/workflows/bot-deploy.yml) +[![Deploy Fetcher Lambda](https://github.com/notdodo/erfiume_bot/actions/workflows/fetcher-deploy.yml/badge.svg)](https://github.com/notdodo/erfiume_bot/actions/workflows/fetcher-deploy.yml)

@@ -24,8 +26,8 @@ The bot can be used in both private or group chats, responding to specific stati The bot consists of two main components: -1. **User interaction**: the code in `./app/erfiume_bot.py` is triggered by a Telegram webhook that starts an AWS Lambda function when a user interacts with the bot. -2. **Stations data update**: the code in `./app/erfiume_fetcher.py` runs on a Lambda function via an EventBridge scheduler, updating the data from the stations. This data is then used by the bot to answer to messages. +1. **User interaction**: the code in `./app/bot` is triggered by a Telegram webhook that starts an AWS Lambda function when a user interacts with the bot. +2. **Stations data update**: the code in `./app/fetcher` runs on a Lambda function via an EventBridge scheduler, updating the data from the stations. This data is then used by the bot to answer to messages. ![](./assets/erfiume.png) @@ -41,7 +43,7 @@ The bot consists of two main components: ## Features -### Telegram Bot (`./app/erfiume_bot.py`) +### Telegram Bot (`./app/bot`) The bot responds to Telegram messages via the main Lambda function and can: @@ -51,11 +53,11 @@ The bot responds to Telegram messages via the main Lambda function and can: What it cannot do: -- read non-command messaged in groups or supergroups +- read non-command messages in groups or supergroups - provide [inline support](https://telegram.org/blog/inline-bots) - support mentions -### Data fetcher (`./app/erfiume_fetcher.py`) +### Data fetcher (`./app/fetcher`) This Lambda function is scheduled to fetch data from the APIs on [Allerta Meteo Emilia Romagna](https://allertameteo.regione.emilia-romagna.it/) and update or create station data in a DynamoDB table. A station refers to a sensor placed on a bridge or river that monitors the water level.