feat: improved README

Author: 0xmikko

README.md

@@ -1,19 +1,70 @@
-![gearbox](header.png)
+# Safe Watcher
 
-# Safe watcher
+This repository contains a bot that monitors one or more Safe addresses for critical activities throughout the entire transaction lifecycle:
 
-This repository contains simple app that watches safe multisig and notifies about various events:
+- **Adding Transactions:** Detects when new transactions are created in the Safe.
+- **Signing Transactions:** Monitors who signs the transactions and how many signatures have been collected.
+- **Executing Transactions:** Sends alerts when a transaction is executed.
 
-- New transaction has been proposed (with some checks about suspicious transactions)
-- Transaction has been signed by one of the signers
-- Transaction has been executed
+Additionally, the bot watches for any suspicious `delegateCall`. If a `delegateCall` is directed to an address other than the trusted `MultiSend` contract, the bot immediately flags it, helping to prevent attacks similar to the Bybit hack.  
+
+Real-time alerts are sent to a configured Telegram channel for immediate notification.
 
 ## Usage
 
-Create config.yaml file with settings. See [config.example.yaml](config.example.yaml) and [schema.ts](src/config/schema.ts) for the reference. 
+To get started, create a `config.yaml` file with your settings. Refer to [config.example.yaml](config.example.yaml) and [schema.ts](src/config/schema.ts) for guidance.
+
+Run the Docker container with your config file mounted:
+
+```bash
+docker run -v $(pwd)/config.yaml:/app/config.yaml ghcr.io/gearbox-protocol/safe-watcher:latest
+```
+
+## Configuration
+
+1. Create a `config.yaml` file in your local directory. You can look at [config.example.yaml](config.example.yaml) and [schema.ts](src/config/schema.ts) for details. Here is an example structure:
+
+   ```yaml
+   telegramBotToken: "xxxx"
+   telegramChannelId: "-1111"
+   safeAddresses:
+     - "eth:0x11111"
+   signers:
+     "0x22222": "alice"
+     "0x33333": "bob"
+   ```
+
+   - **telegramBotToken:** Your Telegram Bot API token (instructions below).
+   - **telegramChannelId:** The ID of the channel or group where alerts will be posted.
+   - **safeAddresses:** One or more Safe addresses to monitor, prefixed by the network identifier (e.g., `eth:` for the Ethereum mainnet).
+   - **signers:** A mapping of addresses to descriptive names (useful for labeling owners in alerts).
 
-Run docker container with config.yaml file mounted to /app/config.yaml
+2. Ensure that `config.yaml` is in the same directory where you plan to run the Docker container.
+
+### Getting a Telegram Bot Token
+
+1. Open the Telegram app and start a chat with `@BotFather`.
+2. Type `/start` if you haven't used BotFather before.
+3. Send the command `/newbot` and follow the prompts:
+   - Provide a name for your bot (display name).
+   - Provide a username for your bot (it must end in "bot", e.g., `MySafeNotifierBot`).
+4. Once the bot is created, BotFather will provide you with an HTTP API token (e.g., `123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11`).
+5. Copy this token and use it as the value for `telegramBotToken` in your `config.yaml`.
+
+### Running via Docker
+
+Run the Docker container with your config file mounted using the following command:
 
 ```bash
-docker run -v $(pwd)/config.local.yaml:/app/config.yaml ghcr.io/gearbox-protocol/safe-watcher:latest
+docker run -v $(pwd)/config.yaml:/app/config.yaml ghcr.io/gearbox-protocol/safe-watcher:latest
 ```
+
+The bot will start and immediately begin monitoring the specified Safe addresses. Any relevant changes or suspicious `delegateCall` attempts will be sent to your Telegram channel.
+
+## License
+
+This project is distributed under the MIT License.
+
+## Disclaimer
+
+This software is provided "as is," without warranties or guarantees of any kind. Use it at your own risk. The maintainers and contributors are not liable for any damages or losses arising from its use. Always exercise caution and follow best security practices when managing crypto assets.