Add README file with usage instructions and requirements
This commit is contained in:
49
README.md
Normal file
49
README.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# uptime-heart
|
||||
|
||||
A small utility in this repository. This README includes the requested image and quick usage instructions.
|
||||
|
||||

|
||||
|
||||
## 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.
|
||||
Reference in New Issue
Block a user