pulse-signage/docs/README.md

Documentation

This folder contains the technical reference material for Pulse Signage.

What’s Here

• API reference - the player HTTP surface and onboarding endpoints.
• Database schema - the tables and data model used by the app.
• WebSocket reference - the live player and snapshot channels.
• Compose guide - Docker Compose deployment and service configuration.

How To Read It

If you want the big picture first, start with the main project README. It gives a plain overview of what Pulse Signage does, while the pages in this folder explain how the pieces work.