Add README.md

2026-03-26 19:03:10 +01:00
parent dac058060e
commit 500459a601
1 changed files with 12 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,12 @@
+# Health-API
+FastAPI system monitoring and remote control service for the smol-pie.
+
+## Features
+- **GET `/status`**: Public endpoint for CPU, Temperature, Memory, and Network stats.
+- **POST `/led/blink`**: Protected endpoint (`x-token` header required) to trigger the LED flash.
+- **GET `/health`**: Simple health check.
+
+## Deployment
+Runs inside a Docker container.
+1. `docker compose up -d`
+2. Ensure a local `.env` file exists with `LUNA_API_TOKEN`.