Add README file with usage instructions and requirements

This commit is contained in:
Space-Banane
2026-02-01 12:04:33 +01:00
parent d5d106c0ab
commit 590eab617f

49
README.md Normal file
View File

@@ -0,0 +1,49 @@
# uptime-heart
A small utility in this repository. This README includes the requested image and quick usage instructions.
![Uptime Heart](https://shx.reversed.dev/u/IOC1gx.jpeg)
## Requirements
- Python 3.8+
- See `requirements.txt` for Python dependencies
## Installation
1. Copy `.env` file and configure your settings:
```bash
cp .env.sample .env
```
Edit `.env` with your actual values:
- `ESP_IP`: IP address of your ESP32 device
- `ESP_API_KEY`: ESPHome API encryption key
- `KUMA_URL`: Your Uptime Kuma instance URL
- `KUMA_KEY`: Uptime Kuma API key
- `POLL_INTERVAL`: Polling interval in seconds (default: 30)
2. Install dependencies:
```bash
pip install -r requirements.txt
```
## Usage
Run the main script:
```bash
python listen.py
```
Alternatively, start with Docker Compose if you prefer:
```bash
docker-compose up -d
```
## Notes
- This README was added to the project root and includes the image URL you provided.