Skip to content

Commit 78c8edd

Browse files
Merge pull request #127 from TheDragonCode/preview/banner-djxcaquz
Update repository banner image
2 parents 198d04e + eefcef2 commit 78c8edd

File tree

1 file changed

+0
-22
lines changed

1 file changed

+0
-22
lines changed

README.md

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,6 @@
55
<img src="https://banners.beyondco.de/GitHub%20Preview%20Updater.png?pattern=topography&style=style_2&fontSize=100px&md=1&showWatermark=1&icon=photograph&theme=light&packageManager=uses%3A&packageName=TheDragonCode%2Fgithub-preview-updater%40v2&description=Lightweight+preview+update+in+your+repository&images=photograph" alt="GitHub Preview Updater">
66
</picture>
77

8-
## Overview
9-
10-
[banners.beyondco.de](https://banners.beyondco.de) is a service that generates beautiful social preview banners for
11-
GitHub projects. The image at the top of this README is an example of such a banner.
12-
13-
The problem is that each banner URL must be manually crafted — you have to fill in the project title, description,
14-
package manager install command, icon, and other parameters by hand, then keep the URL up to date whenever any of
15-
those details change.
16-
17-
**GitHub Preview Updater** is a GitHub Action that automates all of that. It reads your repository metadata
18-
(name, description, package manager), builds the correct banner URL automatically, and keeps the
19-
`<picture>` block in your `README.md` up to date — creating a pull request whenever the banner changes.
20-
21-
### What gets inserted into your README
22-
23-
After the first heading (for example, `# My Project`) the action inserts (or replaces) the following block:
24-
25-
```html
26-
<picture>
27-
<source media="(prefers-color-scheme: dark)" srcset="https://banners.beyondco.de/...&theme=dark">
28-
<img src="https://banners.beyondco.de/...&theme=light" alt="{project_name}">
29-
</picture>
308
```
319
3210
Both a light-theme and a dark-theme variant of the banner are generated automatically.

0 commit comments

Comments
 (0)