From 39ac9f0ad296d8b99d35ec2e6e0e0ca89ebcc892 Mon Sep 17 00:00:00 2001 From: Benjamin Nussbaum Date: Mon, 22 Sep 2025 20:12:51 +0200 Subject: [PATCH] Update README.md --- README.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 7479c61..6664512 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,7 @@ [![tests](https://github.com/usetrmnl/byos_laravel/actions/workflows/test.yml/badge.svg)](https://github.com/usetrmnl/byos_laravel/actions/workflows/test.yml) TRMNL BYOS Laravel is a self-hostable implementation of a TRMNL server, built with Laravel. -It allows you to manage TRMNL devices, generate screens using native plugins, recipes, or the API, and can optionally act as a proxy for the native cloud service (Core). - -If you are looking for a Laravel package designed to streamline the development of both public and private TRMNL plugins, check out [bnussbau/trmnl-laravel](https://github.com/bnussbau/laravel-trmnl). +It allows you to manage TRMNL devices, generate screens using native plugins, recipes (45+ from the [community catalog](https://bnussbau.github.io/trmnl-recipe-catalog/)), or the API, and can also act as a proxy for the native cloud service (Core). ![Screenshot](README_byos-screenshot.png) ![Screenshot](README_byos-screenshot-dark.png) @@ -17,6 +15,7 @@ If you are looking for a Laravel package designed to streamline the development * 📡 Device Information – Display battery status, WiFi strength, firmware version, and more. * 🔍 Auto-Join – Automatically detects and adds devices from your local network. * 🖥️ Screen Generation – Supports Plugins (even Mashups), Recipes, API, Markup, or updates via Code. + * Over 45 compatible open-source recipes are available in the [community catalog](https://bnussbau.github.io/trmnl-recipe-catalog/) * Supported Devices / Apps: TRMNL, ESP32 with TRMNL firmware, [trmnl-android](https://github.com/usetrmnl/trmnl-android), [trmnl-kindle](https://github.com/usetrmnl/byos_laravel/pull/27), … * 🔄 TRMNL API Proxy – Can act as a proxy for the native cloud service (requires TRMNL Developer Edition). * This enables a hybrid setup – for example, you can update your custom Train Monitor every 5 minutes in the morning, while displaying native TRMNL plugins throughout the day. @@ -26,11 +25,6 @@ If you are looking for a Laravel package designed to streamline the development ![Devices](README_byos-devices.jpeg) -### 🎯 Target Audience - -This project is for developers who are looking for a self-hosted server for devices running the TRMNL firmware. -It serves as a starter kit, giving you the flexibility to build and extend it however you like. - ### Support ❤️ This repo is maintained voluntarily by [@bnussbau](https://github.com/bnussbau). @@ -42,6 +36,8 @@ or [GitHub Sponsors](https://github.com/sponsors/bnussbau/) +If you are looking for a Laravel package designed to streamline the development of both public and private TRMNL plugins, check out [bnussbau/trmnl-laravel](https://github.com/bnussbau/laravel-trmnl). + ### Hosting Run everywhere, where Docker is supported: Raspberry Pi, VPS, NAS, Container Cloud Service (Cloud Run, ...).