From 575afffd292775f0e0f9e9bb41481db94b6deef7 Mon Sep 17 00:00:00 2001
From: RTSDA <av@rockvilletollandsda.org>
Date: Sat, 16 Aug 2025 21:59:43 -0400
Subject: [PATCH] docs: simplify README to reflect church-core managed API

Since church-core handles API configuration and connectivity:
- Remove detailed API setup instructions
- Simplify configuration to focus on display settings only
- Note that API connectivity is managed by church-core
- Emphasize that most configuration is automatic
- Remove redundant environment variable examples
- Fix requirements to not assume file structure

The README now accurately reflects that users don't need to
manually configure API endpoints when using church-core.
---
 README.md | 62 ++++++++++++++++++-------------------------------------
 1 file changed, 20 insertions(+), 42 deletions(-)

diff --git a/README.md b/README.md
index fa86617..69808dd 100644
--- a/README.md
+++ b/README.md
@@ -16,59 +16,37 @@ A modern digital signage application for displaying church events, built with Ru
 ## Requirements
 
 - Rust 1.70 or higher
-- Access to the `church-core` crate (located at `../church-core`)
-- A running church API instance with events endpoint
+- church-core crate
+
+**Note:** API connectivity is managed by church-core - no additional setup required.
 
 ## Configuration
 
-You can configure Beacon in three ways (in order of precedence):
+Beacon uses the church-core library for API connectivity, which handles most configuration automatically. You only need to configure display settings:
 
-### 1. Environment Variables
-Configure Beacon using environment variables:
-```bash
-export BEACON_API_URL="https://your-api-url.com"
-export BEACON_WINDOW_WIDTH="1920"
-export BEACON_WINDOW_HEIGHT="1080"
-./beacon
-```
-
-### 2. .env File
-Create a `.env` file in the application directory:
-```bash
-# Copy the example file
-cp .env.example .env
-# Edit with your settings
-nano .env
-```
-
-Example `.env` file:
-```env
-BEACON_API_URL=https://your-api-endpoint.com
-BEACON_WINDOW_WIDTH=1920
-BEACON_WINDOW_HEIGHT=1080
-RUST_LOG=beacon=info
-```
-
-Available environment variables:
-- `BEACON_API_URL` - API endpoint URL
-- `BEACON_WINDOW_WIDTH` - Window width in pixels  
-- `BEACON_WINDOW_HEIGHT` - Window height in pixels
-
-### 3. Config File
-Create a `config.toml` file in the application directory:
+### Optional Configuration File
+Create a `config.toml` file in the application directory for display customization:
 
 ```toml
-api_url = "https://your-api-url.com"
+# Display settings
 window_width = 1920
 window_height = 1080
 slide_interval_seconds = 10
-refresh_interval_minutes = 5
+
+# Optional: Override church-core API settings if needed
+# api_url = "https://your-custom-endpoint.com"
 ```
 
-**Configuration Precedence:**
-1. Environment variables (highest priority)
-2. .env file 
-3. config.toml file (lowest priority)
+### Environment Variables
+You can also configure via environment variables:
+```bash
+export BEACON_WINDOW_WIDTH="1920"
+export BEACON_WINDOW_HEIGHT="1080"
+export RUST_LOG=beacon=info
+./beacon
+```
+
+**Note:** API configuration is handled by church-core and typically doesn't need customization.
 
 ## Building