docs: Update readme.md with tools overview

2024-08-17 13:05:16 -05:00
parent 255153af56
commit e6f4cafab6
1 changed files with 10 additions and 1 deletions
@@ -8,3 +8,12 @@
 ## Running the code (Any)
 1. Run telegram_inference_bot.py after entering the environment
 2. now we're cooking with gas!
+
+## Tools Overview
+
+The `tools` directory contains essential utilities that extend the capabilities of the main application. Below are key Python files and their roles:
+1. **tools/base_tool.py**:
+ - **Purpose**: Serves as an abstract base class for other tools.
+ - **Core Methods**:
+ `get_functions()`: Abstract method to list available functions.
+ `execute(function_name, **kwargs)`: Abstract method to execute a specified function with given arguments.