From ba00a35253e01e7db51d3b026b217c15056ac351 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 24 Feb 2026 12:13:11 +0000 Subject: [PATCH 1/3] Initial plan From 680f942a40ced62e419a32401809e0bb5c25da6d Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 24 Feb 2026 12:15:27 +0000 Subject: [PATCH 2/3] docs: improve README clarity with better overview and how-it-works section Co-authored-by: andrey-helldar <10347617+andrey-helldar@users.noreply.github.com> --- README.md | 33 ++++++++++++++++++++++++++++++--- 1 file changed, 30 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 971b093..b677b99 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,36 @@ ## Overview -GitHub Action that generates an always-fresh preview banner for your project and keeps it at the top of your -`README.md`. The action detects your package manager, builds a light/dark banner, replaces any previous preview block, -commits the change in a dedicated branch, and opens a pull request with optional assignees and labels. +[banners.beyondco.de](https://banners.beyondco.de) is a service that generates beautiful social preview banners for +GitHub projects. The image at the top of this README is an example of such a banner. + +The problem is that each banner URL must be manually crafted — you have to fill in the project title, description, +package manager install command, icon, and other parameters by hand, then keep the URL up to date whenever any of +those details change. + +**GitHub Preview Updater** is a GitHub Action that automates all of that. It reads your repository metadata +(name, description, package manager), builds the correct banner URL automatically, and keeps the +`` block in your `README.md` up to date — creating a pull request whenever the banner changes. + +### What gets inserted into your README + +After the first heading (`# My Project`) the action inserts (or replaces) the following block: + +```html + + + My Project + +``` + +Both a light-theme and a dark-theme variant of the banner are generated automatically. + +### How it works + +1. The action reads your `composer.json` / `package.json` to detect the package manager, package name, and description. +2. It builds the banner URL for [banners.beyondco.de](https://banners.beyondco.de) using the collected data. +3. It replaces the `` block in your `README.md` with the freshly generated URLs. +4. If the file changed, it commits the update to a new branch and opens a pull request. ## Quick start From 22ec274b724ef78dd2d47abbd5aad1369798e02c Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 24 Feb 2026 12:50:37 +0000 Subject: [PATCH 3/3] docs: apply review suggestions to README overview section Co-authored-by: andrey-helldar <10347617+andrey-helldar@users.noreply.github.com> --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b677b99..d9172c1 100644 --- a/README.md +++ b/README.md @@ -20,12 +20,12 @@ those details change. ### What gets inserted into your README -After the first heading (`# My Project`) the action inserts (or replaces) the following block: +After the first heading (for example, `# My Project`) the action inserts (or replaces) the following block: ```html - - My Project + + {project_name} ```