new readme #25

Merged
letteka merged 2 commits from readme into main 2026-05-16 16:45:19 -07:00
Showing only changes of commit 0c00e14605 - Show all commits
+4 -4
View File
@@ -1,10 +1,10 @@
# BirdCam2: A Flask-Based Camera Monitoring System # BirdCam: A Flask-Based Camera Monitoring System
A lightweight, Python-based system for monitoring and managing Raspberry Pi cameras using Flask, SQLAlchemy, and modern Python best practices. A lightweight, Python-based system for monitoring and managing Raspberry Pi cameras using Flask, SQLAlchemy, and modern Python best practices.
## 🚀 Overview ## 🚀 Overview
BirdCam2 is a simple yet robust application designed to monitor camera status and log events in real time. Built with Flask and SQLAlchemy, it provides: BirdCam is a simple yet robust application designed to monitor camera status and log events in real time. Built with Flask and SQLAlchemy, it provides:
- Real-time camera status tracking (`running` state). - Real-time camera status tracking (`running` state).
- Event logging for camera actions (`start`, `stop`) with IP addresses and timestamps. - Event logging for camera actions (`start`, `stop`) with IP addresses and timestamps.
- A clean, maintainable architecture using modern Python 3.12 features and type hints. - A clean, maintainable architecture using modern Python 3.12 features and type hints.
@@ -42,8 +42,8 @@ It's ideal for hobbyists, developers, or IoT projects where you need to track ca
1. Clone the repository: 1. Clone the repository:
```bash ```bash
git clone https://github.com/your-username/birdcam2.git git clone https://gitea.letteka.com/letteka/birdcam.git
cd birdcam2 cd birdcam
``` ```
2. Install dependencies: 2. Install dependencies: