Beacon/README.md
RTSDA dd3d171e3a Add LICENSE and update README for new repository
- Add MIT LICENSE file
- Update README.md to reflect new API integration
- Include all recent changes to migrate from PocketBase to church API
2025-08-16 18:48:02 -04:00

992 B

Beacon

A modern digital signage application for displaying church events, built with Rust and Iced.

Features

  • Real-time event display with automatic updates
  • Smooth image loading and transitions
  • Modern, clean interface design
  • Automatic event filtering based on date/time
  • Support for high-resolution displays
  • Efficient memory management for images

Requirements

  • Rust 1.70 or higher
  • A running church API instance with events endpoint

Configuration

Create a config.toml file in the application directory with the following settings:

api_url = "http://your-church-api-url"
window_width = 1920
window_height = 1080
slide_interval_secs = 10
refresh_interval_mins = 5

Building

cargo build --release

Running

./target/release/beacon

Development

The application is built using:

  • Iced for the UI framework
  • Tokio for async runtime
  • Reqwest for HTTP requests
  • Chrono for date/time handling

License

MIT License