# Documentation

This folder contains the technical reference material for Pulse Signage.

## What’s Here

- [API reference](api.md) - the player HTTP surface and onboarding endpoints.
- [Database schema](schema.md) - the tables and data model used by the app.
- [WebSocket reference](websocket.md) - the live player and snapshot channels.
- [Compose guide](../docker-compose/README.md) - Docker Compose deployment and service configuration.

## How To Read It

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