From 500459a60188fbe5489f3db648e1dc6e80ad05c1 Mon Sep 17 00:00:00 2001 From: Luna Date: Thu, 26 Mar 2026 19:03:10 +0100 Subject: [PATCH] Add README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ad35576 --- /dev/null +++ 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`.