Zum Inhalt springen
RepoReady
Registrieren
Menü
Menü der Dokumentation

Das README-Badge

Was das Badge zeigt, wie Sie es einbinden, wie es aktuell bleibt und was ein Klick darauf öffnet.

Zuletzt aktualisiert

Das Badge zeigt den Score einer Analyse Ihrer Wahl und verlinkt deren Bericht. Wofür das Badge gut ist erklärt den Nutzen, diese Seite die Funktionsweise.

Was es zeigt

Das Badge trägt den Score der angehefteten Analyse von 0 bis 100, in der Farbe seiner Kategorie. Die Bereiche stehen unter So funktioniert der Score.

Solange kein Score vorliegt, sagt das Badge genau das:

  • analyzing..., während die Analyse läuft.
  • pending, wenn die angeheftete Analyse keinen Score ergeben hat.
  • not found, nachdem das Badge entfernt wurde.

Einbinden

  1. Analysieren Sie das Repository, in der Web-App oder mit Ihrem Coding-Agenten.
  2. Heften Sie die gewünschte Analyse an. Ihr Bericht wird öffentlich, wählen Sie also eine, die alle lesen dürfen.
  3. Fügen Sie das Badge ins README ein: RepoReady öffnet einen Pull Request, oder Sie kopieren das Markdown.

Die App liefert die fertige Zeile. Sie hat diese Form:

README.md
[![RepoReady](https://img.shields.io/endpoint?url=<endpoint>)](https://app.repoready.ai/shared/badges/<badge-id>)

Das Bild kommt von shields.io und liest ein kleines JSON-Dokument von api.repoready.ai. Kopieren Sie die Zeile aus der App, statt sie abzutippen: Die Badge-ID gehört nur zu Ihrem Projekt.

Aktuell halten

  • Repository verbessert? Analysieren Sie erneut und heften Sie die neuere Analyse an. Badge-ID und Zeile im README bleiben gleich.
  • Ein neuer Score erreicht Lesende innerhalb weniger Minuten. RepoReady erlaubt eine Minute Caching, shields.io cacht das Bild zusätzlich.
  • Das Badge löst immer die aktuell angeheftete Analyse auf. Auch ein ein Jahr altes README zeigt damit aktuelle Zahlen.

Was Besuchende sehen

Ein Klick öffnet den vollständigen Bericht: den Score, jeden Befund mit Schweregrad und Beleg sowie die Korrekturvorschläge. Ein Konto ist nicht nötig.

  • Öffentlich ist nur die angeheftete Analyse. Andere Analysen, andere Projekte und Ihr Konto bleiben privat.
  • Öffentliche Berichtsseiten werden von Suchmaschinen nicht indexiert; wer den Link hat, erreicht sie.
  • Datenverarbeitung beschreibt im Detail, wer was sehen kann.

Entfernen

  • Lösen Sie das Badge in der Web-App. Die URL löst sofort nicht mehr auf, und der Bericht ist wieder privat.
  • Wo das Badge noch eingebunden ist, erscheint danach das Ersatzbild von shields.io. Löschen Sie die Zeile also auch aus Ihrem README.