diff --git a/README.md b/README.md index 0d50c38e..c0791461 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,14 @@ I'm trying to be open to constructive criticism and support, as long as it's a r
Core Features -The following plugins are available inside of the LEDMatrix project. These modular, rotating Displays that can be individually enabled or disabled per the user's needs with some configuration around display durations, teams, stocks, weather, timezones, and more. Displays include: +LEDMatrix is a plugin platform: the displays below are plugins installed +from the built-in Plugin Store (web interface → Plugins), where each can be +individually enabled, ordered, and configured — display durations, teams, +stocks, weather, timezones, and more. The core repo ships with just two +bundled plugins (`starlark-apps` and `web-ui-info`); everything else lives +in the [ledmatrix-plugins](https://github.com/ChuckBuilds/ledmatrix-plugins) +monorepo and installs with one click. Displays available in the store +include: ### Time and Weather - Real-time clock display (2x 64x32 Displays 4mm Pixel Pitch) @@ -372,6 +379,10 @@ This single script installs services, dependencies, configures permissions and s ### Initial Setup +For a complete list of every key in `config.json` and +`config_secrets.json`, see +[docs/CONFIG_REFERENCE.md](docs/CONFIG_REFERENCE.md). + For most settings I recommend using the web interface: Edit the project via the web interface at http://[IP ADDRESS or HOSTNAME]:5000 or http://ledpi:5000 . @@ -610,12 +621,7 @@ These settings control runtime behavior and GPIO timing: ### Display Durations (`display.display_durations`) -Controls how long each display module stays visible in seconds before switching to the next one. - -- **`calendar`** (integer, default: 30) - - Duration in seconds for the calendar display - - Increase for more time to read dates/events - - Decrease to cycle through other displays faster +Controls how long each installed plugin stays visible in seconds before switching to the next one, keyed by plugin id. - **Plugin-specific durations** - Each plugin can have its own duration setting