Files
kr0sh512 d7f499e5c6 - add example config
- add command to configure time for reminds
- little refactoring in tg and for_db
2024-11-11 23:37:15 +03:00

39 lines
829 B
Markdown

# TG Keeper
TG Keeper bot allows you to store notes, display them at a specified interval, and recognizes date formats: DD.MM, DD month. It works both in group chats by mentioning @username_bot and in private messages.
## Features
- Convenient setup interface
- Dependency installation via `requirements.txt`
- Initial configuration in the `config.yaml` file
## Installation
1. Clone the repository:
```sh
git clone https://github.com/yourusername/tg-keeper.git
```
2. Navigate to the project directory:
```sh
cd tg-keeper
```
3. Install the dependencies:
```sh
pip install -r requirements.txt
```
## Configuration
1. Open the `config.yaml` file and configure the parameters as you wish.
## Usage
Run the bot:
```sh
python bot.py
```
Now you can add and manage your notes through TG Keeper.