diff --git a/README.md b/README.md index 74ef3d30f..76aa5ff63 100644 --- a/README.md +++ b/README.md @@ -8,36 +8,52 @@ This repository holds various examples that showcases Screenly's features and AP If you are not familiar with Edge Apps, we suggest you review our [developer documentation](https://developer.screenly.io/edge-apps/#getting-started). -- [3D Text](https://github.com/Screenly/3d-text-app/) - A 3D text display app that renders text with depth and shadow effects. _(Moved to a separate repository)_ -- [8bit Fireplace](https://github.com/Screenly/8bit-fireplace/) - A full-screen 8-bit fireplace rendered as pixel art. _(Moved to a separate repository)_ -- [Asset Metadata](https://github.com/Screenly/asset-metadata-app/) - An example implementation of Screenly's metadata. _(Moved to a separate repository)_ -- [BambooHR App](https://github.com/Screenly/bamboo-hr-app/) - Displays employee birthdays, work anniversaries and other HR events from BambooHR. _(Moved to a separate repository)_ -- [Calendar App](https://github.com/Screenly/calendar-app/) - A simple calendar app that shows events from iCal data. _(Moved to a separate repository)_ -- [CAP Alerting](https://github.com/Screenly/cap-alerting-app/) - Display Common Alerting Protocol (CAP) emergency alerts on Screenly digital signage screens. _(Moved to a separate repository)_ -- [CharlieHR App](https://github.com/Screenly/charlie-hr-app/) - Displays employee birthdays, work anniversaries and other HR events from CharlieHR. _(Moved to a separate repository)_ -- [Clock App](https://github.com/Screenly/clock-edge-app/) - A simple clock app. _(Moved to a separate repository)_ -- [Countdown Timer](https://github.com/Screenly/countdown-timer-app/) - A simple countdown timer app. _(Moved to a separate repository)_ -- [Daylight App](https://github.com/Screenly/daylight-app) - Sunrise, sunset, twilight and moon phase for a screen, computed on the player with no network access. _(Moved to a separate repository)_ -- [Demo Dashboard](https://github.com/Screenly/demo-dashboard-app/) - A collection of demo dashboards. _(Moved to a separate repository)_ -- [Flying Toasters App](https://github.com/Screenly/flying-toasters-app/) - A simple toaster app that flies around the screen. _(Moved to a separate repository)_ -- [Google Calendar App](https://github.com/Screenly/google-calendar-app/) - A simple calendar app that shows events from Google Calendar. _(Moved to a separate repository)_ -- [Grafana Dashboard](https://github.com/Screenly/grafana-app/) - Displays Grafana dashboards as images on Screenly screens with automatic refresh intervals. _(Moved to a separate repository)_ -- [iframe App](https://github.com/Screenly/iframe-app/) - A simple iframe app. _(Moved to a separate repository)_ -- [Menu Board App](https://github.com/Screenly/menu-board-app/) - A dynamic menu board that can display up to 25 menu items. _(Moved to a separate repository)_ -- [Outlook Calendar App](https://github.com/Screenly/outlook-calendar-app/) - A simple calendar app that shows events from Outlook Calendar. _(Moved to a separate repository)_ -- [Power BI](https://github.com/Screenly/powerbi-app/) - A Power BI Edge App for securely accessing dashboards and reports. _(Moved to a separate repository)_ -- [QR Code Generator](https://github.com/Screenly/qr-code-app/) - A QR code generator app with customizable header and UTM tracking. _(Moved to a separate repository)_ -- [QR WiFi App](https://github.com/Screenly/qr-wifi-app) - Instantly share Wi-Fi credentials on your digital signage screens with this lightweight QR code generator for Screenly Apps. -- [RSS Reader](https://github.com/Screenly/rss-reader-app/) - A simple RSS reader. _(Moved to a separate repository)_ -- [Simple Message App](https://github.com/Screenly/simple-message-app/) - A simple message app. _(Moved to a separate repository)_ -- [Simple Table App](https://github.com/Screenly/simple-table-app/) - A minimalist edge app for Screenly that displays CSV data as a beautifully formatted table. _(Moved to a separate repository)_ -- [Simple Timer App](https://github.com/Screenly/simple-timer-app/) - A simple timer app. _(Moved to a separate repository)_ -- [Sonar Dashboard](https://github.com/Screenly/Playground/tree/master/edge-apps/sonar-dashboard) - A dashboard that displays the status of the [Sonar - BLE Device Counter](https://github.com/Viktopia/sonar). -- [Strava Club Leaderboard](https://github.com/Screenly/strava-club-leaderboard-app/) - A leaderboard of Strava club activities. _(Moved to a separate repository)_ -- [TFL Bus Status App](https://github.com/Screenly/tfl-bus-status-app/) - An app to display TFL Bus Status for a given bus stop. _(Moved to a separate repository)_ -- [TradingView Widgets App](https://github.com/Screenly/tradingview-widgets-app/) - Displays TradingView widgets such as charts, tickers, and market data. -- [Weather App](https://github.com/Screenly/weather-app/) - A simple weather app. _(Moved to a separate repository)_ -- [Welcome App](https://github.com/Screenly/welcome-app/) - A customizable welcome screen app. _(Moved to a separate repository)_ +Most Edge Apps now live in their own repositories under the Screenly organization. The version badge shows each app's latest GitHub release. + +| App | Description | Version | +| ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [3D Text](https://github.com/Screenly/3d-text-app) | A 3D text display app that renders text with depth and shadow effects. | [![Version](https://img.shields.io/github/v/release/Screenly/3d-text-app)](https://github.com/Screenly/3d-text-app/releases/latest) | +| [8bit Fireplace](https://github.com/Screenly/8bit-fireplace-app) | A full-screen 8-bit fireplace rendered as pixel art. | [![Version](https://img.shields.io/github/v/release/Screenly/8bit-fireplace-app)](https://github.com/Screenly/8bit-fireplace-app/releases/latest) | +| [Airtable](https://github.com/Screenly/airtable-app) | Displays data from an Airtable base. | [![Version](https://img.shields.io/github/v/release/Screenly/airtable-app)](https://github.com/Screenly/airtable-app/releases/latest) | +| [Asset Metadata](https://github.com/Screenly/asset-metadata-app) | Displays screen metadata like position, coordinates and hostname. | [![Version](https://img.shields.io/github/v/release/Screenly/asset-metadata-app)](https://github.com/Screenly/asset-metadata-app/releases/latest) | +| [BambooHR](https://github.com/Screenly/bamboo-hr-app) | Displays employee birthdays, work anniversaries and who's on leave today, sourced from BambooHR. | [![Version](https://img.shields.io/github/v/release/Screenly/bamboo-hr-app)](https://github.com/Screenly/bamboo-hr-app/releases/latest) | +| [Calendar](https://github.com/Screenly/calendar-app) | Shows events from iCal data. | [![Version](https://img.shields.io/github/v/release/Screenly/calendar-app)](https://github.com/Screenly/calendar-app/releases/latest) | +| [CAP Alerting](https://github.com/Screenly/cap-alerting-app) | Displays Common Alerting Protocol (CAP) emergency alerts. | [![Version](https://img.shields.io/github/v/release/Screenly/cap-alerting-app)](https://github.com/Screenly/cap-alerting-app/releases/latest) | +| [CharlieHR](https://github.com/Screenly/charlie-hr-app) | Displays employee birthdays, work anniversaries and other HR events from CharlieHR. | [![Version](https://img.shields.io/github/v/release/Screenly/charlie-hr-app)](https://github.com/Screenly/charlie-hr-app/releases/latest) | +| [Clock](https://github.com/Screenly/clock-app) | A clock with the local time, date and weather. | [![Version](https://img.shields.io/github/v/release/Screenly/clock-app)](https://github.com/Screenly/clock-app/releases/latest) | +| [Countdown Timer](https://github.com/Screenly/countdown-timer-app) | A countdown timer. | [![Version](https://img.shields.io/github/v/release/Screenly/countdown-timer-app)](https://github.com/Screenly/countdown-timer-app/releases/latest) | +| [Daylight](https://github.com/Screenly/daylight-app) | Sunrise, sunset, twilight and moon phase for a screen, computed on the player with no network access. | [![Version](https://img.shields.io/github/v/release/Screenly/daylight-app)](https://github.com/Screenly/daylight-app/releases/latest) | +| [Demo Dashboard](https://github.com/Screenly/demo-dashboard-app) | A collection of demo dashboards. | [![Version](https://img.shields.io/github/v/release/Screenly/demo-dashboard-app)](https://github.com/Screenly/demo-dashboard-app/releases/latest) | +| [Earthquake](https://github.com/Screenly/Earthquake-App) | A map centred on the screen's location, calling out the nearest recent earthquake. | [![Version](https://img.shields.io/github/v/release/Screenly/Earthquake-App)](https://github.com/Screenly/Earthquake-App/releases/latest) | +| [Flying Toasters](https://github.com/Screenly/flying-toasters-app) | The classic flying toasters screensaver. | [![Version](https://img.shields.io/github/v/release/Screenly/flying-toasters-app)](https://github.com/Screenly/flying-toasters-app/releases/latest) | +| [Frankfurter Exchange Rates](https://github.com/Screenly/frankfurter-exchange-rates-app) | Daily currency exchange rates from central banks. | [![Version](https://img.shields.io/github/v/release/Screenly/frankfurter-exchange-rates-app)](https://github.com/Screenly/frankfurter-exchange-rates-app/releases/latest) | +| [Google Calendar](https://github.com/Screenly/google-calendar-app) | Shows events from Google Calendar. | [![Version](https://img.shields.io/github/v/release/Screenly/google-calendar-app)](https://github.com/Screenly/google-calendar-app/releases/latest) | +| [Grafana Dashboard](https://github.com/Screenly/grafana-app) | Displays Grafana dashboards as images with automatic refresh intervals. | [![Version](https://img.shields.io/github/v/release/Screenly/grafana-app)](https://github.com/Screenly/grafana-app/releases/latest) | +| [iframe](https://github.com/Screenly/iframe-app) | Loads another web page or dashboard in an iframe. | [![Version](https://img.shields.io/github/v/release/Screenly/iframe-app)](https://github.com/Screenly/iframe-app/releases/latest) | +| [Instagram](/edge-apps/instagram) | Displays the latest two posts from an Instagram account. _(In this repository)_ | — | +| [Meal Schedules](https://github.com/Screenly/meal-schedules-app) | Meal service times for hotels and restaurants, on a board readable across a room. | [![Version](https://img.shields.io/github/v/release/Screenly/meal-schedules-app)](https://github.com/Screenly/meal-schedules-app/releases/latest) | +| [Menu Board](https://github.com/Screenly/menu-board-app) | A dynamic menu board that can display up to 25 menu items. | [![Version](https://img.shields.io/github/v/release/Screenly/menu-board-app)](https://github.com/Screenly/menu-board-app/releases/latest) | +| [OpenSky Flight Map](https://github.com/Screenly/opensky-live-app) | Live OpenSky air traffic on a full-bleed map, around the screen, an airport or a single flight. | [![Version](https://img.shields.io/github/v/release/Screenly/opensky-live-app)](https://github.com/Screenly/opensky-live-app/releases/latest) | +| [Outlook Calendar](https://github.com/Screenly/outlook-calendar-app) | Shows events from Outlook Calendar. | [![Version](https://img.shields.io/github/v/release/Screenly/outlook-calendar-app)](https://github.com/Screenly/outlook-calendar-app/releases/latest) | +| [Power BI](https://github.com/Screenly/powerbi-app) | Securely displays Power BI dashboards and reports. | [![Version](https://img.shields.io/github/v/release/Screenly/powerbi-app)](https://github.com/Screenly/powerbi-app/releases/latest) | +| [Power BI (Legacy)](https://github.com/Screenly/powerbi-legacy-app) | The legacy Power BI app. | [![Version](https://img.shields.io/github/v/release/Screenly/powerbi-legacy-app)](https://github.com/Screenly/powerbi-legacy-app/releases/latest) | +| [Puzzel Dashboard](https://github.com/Screenly/puzzel-dashboard-app) | Displays Puzzel contact centre queue statistics. | [![Version](https://img.shields.io/github/v/release/Screenly/puzzel-dashboard-app)](https://github.com/Screenly/puzzel-dashboard-app/releases/latest) | +| [QR Code Generator](https://github.com/Screenly/qr-code-app) | A QR code generator with a customizable header and UTM tracking. | [![Version](https://img.shields.io/github/v/release/Screenly/qr-code-app)](https://github.com/Screenly/qr-code-app/releases/latest) | +| [Queue Management System](/edge-apps/queue-management-system) | A proof-of-concept queue management system that directs retail customers to available tills. _(In this repository)_ | — | +| [RSS Reader](https://github.com/Screenly/rss-reader-app) | Displays the latest entries from any RSS feed. | [![Version](https://img.shields.io/github/v/release/Screenly/rss-reader-app)](https://github.com/Screenly/rss-reader-app/releases/latest) | +| [Salesforce](https://github.com/Screenly/salesforce-app) | A Salesforce analytics dashboard. | [![Version](https://img.shields.io/github/v/release/Screenly/salesforce-app)](https://github.com/Screenly/salesforce-app/releases/latest) | +| [Shopify Dashboard](https://github.com/Screenly/shopify-dashboard-app) | A Shopify store dashboard. | [![Version](https://img.shields.io/github/v/release/Screenly/shopify-dashboard-app)](https://github.com/Screenly/shopify-dashboard-app/releases/latest) | +| [Simple Message](https://github.com/Screenly/simple-message-app) | Displays a simple message. | [![Version](https://img.shields.io/github/v/release/Screenly/simple-message-app)](https://github.com/Screenly/simple-message-app/releases/latest) | +| [Simple Table](https://github.com/Screenly/simple-table-app) | Displays CSV data as a formatted table. | [![Version](https://img.shields.io/github/v/release/Screenly/simple-table-app)](https://github.com/Screenly/simple-table-app/releases/latest) | +| [Simple Timer](https://github.com/Screenly/simple-timer-app) | A simple timer. | [![Version](https://img.shields.io/github/v/release/Screenly/simple-timer-app)](https://github.com/Screenly/simple-timer-app/releases/latest) | +| [Slack Messages](https://github.com/Screenly/slack-messages-app) | Displays the latest message from a Slack channel, full screen. | [![Version](https://img.shields.io/github/v/release/Screenly/slack-messages-app)](https://github.com/Screenly/slack-messages-app/releases/latest) | +| [Sonar Dashboard](/edge-apps/sonar-dashboard) | Displays the status of the [Sonar - BLE Device Counter](https://github.com/Viktopia/sonar). _(In this repository)_ | — | +| [Strava Club Leaderboard](https://github.com/Screenly/strava-club-leaderboard-app) | A leaderboard of Strava club activities. | [![Version](https://img.shields.io/github/v/release/Screenly/strava-club-leaderboard-app)](https://github.com/Screenly/strava-club-leaderboard-app/releases/latest) | +| [TfL Bus Status](https://github.com/Screenly/tfl-bus-status-app) | Displays TfL bus status for a given bus stop. | [![Version](https://img.shields.io/github/v/release/Screenly/tfl-bus-status-app)](https://github.com/Screenly/tfl-bus-status-app/releases/latest) | +| [TradingView Widgets](https://github.com/Screenly/tradingview-widgets-app) | Displays TradingView widgets such as charts, tickers and market data. | [![Version](https://img.shields.io/github/v/release/Screenly/tradingview-widgets-app)](https://github.com/Screenly/tradingview-widgets-app/releases/latest) | +| [Weather](https://github.com/Screenly/weather-app) | Current weather and forecast for the screen's location. | [![Version](https://img.shields.io/github/v/release/Screenly/weather-app)](https://github.com/Screenly/weather-app/releases/latest) | +| [Welcome](https://github.com/Screenly/welcome-app) | A customizable welcome screen. | [![Version](https://img.shields.io/github/v/release/Screenly/welcome-app)](https://github.com/Screenly/welcome-app/releases/latest) | +| [Wi-Fi QR Share](https://github.com/Screenly/wifi-connect-app) | Shares Wi-Fi credentials on screen as a QR code. | [![Version](https://img.shields.io/github/v/release/Screenly/wifi-connect-app)](https://github.com/Screenly/wifi-connect-app/releases/latest) | ### Creating a New Edge App @@ -53,5 +69,4 @@ Details on how to use the library can be found in the [`@screenly/edge-apps` pac - [Bootstrap](https://github.com/Screenly/playground/tree/master/bootstrap/): A digital signage optimized Bootstrap theme for our Playground apps. - [Dynamic Playlists](https://github.com/Screenly/playground/tree/master/dynamic-playlists/): An example of how to use Screenly's API to enable/disable a playlist based on weather conditions. -- [Instagram App](https://github.com/Screenly/playground/tree/master/instagram/): A basic Instagram app for Screenly. - [JavaScript Injectors](https://github.com/Screenly/playground/tree/master/javascript-injectors/): Examples showing Screenly's JavaScript Injector.