Skip to content

Commit f9db00d

Browse files
author
SIN CI
committed
feat: skill-github-readme — SOTA README order + chart full-width + footer repo name
- Template order updated: H1 Title → Tagline → Badges → Quick Links → Hero Banner → Content → Footer Banner - Charts full-width (no width="640") - Footer banner alt text: 'OpenSIN AI — {{REPO_NAME}}'
1 parent 5c01f99 commit f9db00d

1 file changed

Lines changed: 18 additions & 16 deletions

File tree

  • skills/github-skills/skill-github-readme

skills/github-skills/skill-github-readme/SKILL.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ sin-code image-graph -> "Daten visualisieren" (sin-code image-graph)
6161
Based on deep research of 10 top GitHub repos (186k to 3.6k stars):
6262

6363
```
64-
Hero Image (optional) -> Badges -> Tagline -> Quick Links -> Quick Start ->
65-
Features -> Stats/Charts -> Models/Details -> API/Usage ->
66-
Architecture -> Contributing -> License -> Footer
64+
H1 Title + One-Line Description -> Badges -> Tagline -> Quick Links ->
65+
Hero Banner -> Quick Start -> Features -> Stats/Charts -> Models/Details ->
66+
API/Usage -> Architecture -> Contributing -> License -> Footer Banner
6767
```
6868

6969
**Keine starren Regeln — orientiere dich an den Top-Repos, passe an dein Repo an.**
@@ -288,8 +288,6 @@ Beide Banner sind **custom-designed SVGs** (NICHT shields.io badges). Sie nutzen
288288
#### 10a. Header Hero Banner (individuell pro Repo)
289289

290290
```html
291-
<a name="readme-top"></a>
292-
293291
<picture>
294292
<source media="(prefers-color-scheme: dark)" srcset="./assets/hero-banner.svg" />
295293
<source media="(prefers-color-scheme: light)" srcset="./assets/hero-banner-light.svg" />
@@ -347,8 +345,8 @@ Resize logo to 60×60 before encoding (~8KB base64).
347345

348346
**Was das Footer-Banner zeigt (gleich für alle Repos):**
349347
- **"OpenSIN AI"** (gradient text, `ui-sans-serif, system-ui`, weight 500)
350-
- **Tagline**: "Enterprise AI agents that work autonomously"
351-
- **Repo-specific benefits** (3 Items, pipe-separated, z.B. "484 free API keys · 10-proxy auto-failover · 12 Fireworks models")
348+
- **Tagline**: "{{REPO_NAME}}" — the GitHub repo name (e.g. `SINator-FireworksAI`)
349+
- **Repo-specific benefits** (3 Items, pipe-separated, e.g. "484 free API keys · 10-proxy auto-failover · 12 Fireworks models")
352350
- **OpenSIN logo** (embedded als base64 data URI, 100×100px)
353351
- **Hex grid + neon glow + pulse ring + scanning line** (gleiche Design Language)
354352

@@ -374,6 +372,12 @@ Resize logo to 60×60 before encoding (~8KB base64).
374372
```markdown
375373
<a name="readme-top"></a>
376374

375+
# {{REPO_NAME}}
376+
377+
<p align="center">
378+
<em>{{ONE_SENTENCE_BENEFIT}}</em>
379+
</p>
380+
377381
<!-- BADGES (max 3-4) -->
378382
<p align="center">
379383
<a href="https://pypi.org/project/{{PACKAGE}}/">
@@ -387,11 +391,6 @@ Resize logo to 60×60 before encoding (~8KB base64).
387391
</a>
388392
</p>
389393

390-
<!-- TAGLINE -->
391-
<p align="center">
392-
<em>{{ONE_SENTENCE_BENEFIT}}</em>
393-
</p>
394-
395394
<!-- QUICK LINKS (pipe-separated, Rust pattern) -->
396395
<p align="center">
397396
<a href="#quick-start">Quick Start</a> |
@@ -408,8 +407,6 @@ Resize logo to 60×60 before encoding (~8KB base64).
408407

409408
---
410409

411-
# {{REPO_NAME}}
412-
413410
{{TWO_SENTENCE_DESCRIPTION}}
414411

415412
## Quick Start
@@ -597,10 +594,15 @@ echo '{"title":"Pool Status","items":[{"label":"Available","value":41},{"label":
597594

598595
**WICHTIG:** Charts muessen auf GitHub (Light-Mode!) lesbar sein. Wenn du dunkle Charts generierst, teste sie vorher mit `sin-brain_open_image_in_preview`. GitHub's README-Viewer ist Light-Mode by default.
599596

600-
**Embed in README:**
597+
**Embed in README (VOLLBREITE — kein width!):**
598+
```markdown
599+
![Chart Title](./assets/chart-name.png)
600+
```
601+
602+
Oder fuer zentrierte Vollbreite:
601603
```html
602604
<p align="center">
603-
<img src="./assets/chart-name.png" alt="Chart Title" width="640" />
605+
<img src="./assets/chart-name.png" alt="Chart Title" />
604606
</p>
605607
```
606608

0 commit comments

Comments
 (0)