ForHosting KIT · Entwickler-Tools

Statt einer leeren README

Diese Funktion liest die Struktur und zentrale Dateien eines Repositorys und erzeugt daraus eine README-Datei mit Projektbeschreibung, Installationsschritten, Nutzungsbeispielen und Struktur. Gedacht für alle, die ein neues oder bislang unbeschriebenes Projekt schnell mit einer brauchbaren Grundlage versehen möchten, statt bei einer leeren Datei zu beginnen.

● Betapro Anfrage + pro Repository$0.003

Ausführen — $0.003 + $0.0135/Repository API ansehen

Nutzen Sie es über WebAPIE-MailApp baldTelegram bald

Online ausführen

Führen Sie dies mit Ihrem Konto auf unseren Servern aus. Kostenlose Tools laufen in Ihrem Browser; dieses wird zum oben genannten Preis von Ihrem KIT-Guthaben abgebucht.

Was in die README einfließt

Sie reichen die Dateiliste, die zentralen Konfigurationsdateien wie package.json oder pyproject.toml sowie auf Wunsch ein kurzes Briefing zum Projekt ein; die Funktion erzeugt daraus eine README mit Projektbeschreibung, Installationsanleitung, einem Nutzungsbeispiel und einer kurzen Übersicht der Ordnerstruktur. Je genauer das Briefing – etwa der eigentliche Zweck des Projekts und die Zielgruppe –, desto treffender fällt die erzeugte Projektbeschreibung aus, statt sich auf allgemeine Formulierungen zu beschränken.

Ein Entwurf, keine fertige Dokumentation

Das Ergebnis ist ein strukturierter erster Entwurf, der die offensichtlichen Punkte abdeckt – wie installiert man das Projekt, wie startet man es, welche Ordner gibt es. Projektspezifische Details wie Lizenzwahl, Beitragsrichtlinien oder der Kontakt für Sicherheitsmeldungen sollten ergänzt werden, bevor die README veröffentlicht wird. Auch Besonderheiten, die nur im Kopf der Autorin oder des Autors stecken – etwa ein bekannter, noch ungelöster Fallstrick bei der Installation –, gehören nachträglich ergänzt.

Aktueller Stand: Beta

Diese Funktion befindet sich in der Beta-Phase: Bei Projekten mit klarer, konventioneller Struktur – etwa einem typischen Node.js- oder Python-Projekt – ist der Entwurf meist direkt brauchbar, bei ungewöhnlichen oder sehr großen Repositorys kann die Übersicht unvollständig bleiben. Ein kurzer Blick vor der Veröffentlichung bleibt empfehlenswert. KIT weist den Beta-Status offen aus, statt eine Vollständigkeit zu versprechen, die bei jedem Projektzuschnitt gleichermaßen zutrifft.

Preis pro Repository

Eine erzeugte README kostet $0.003 Grundgebühr plus $0.0135, insgesamt rund $0.017 pro Repository. Über die API lässt sich die Funktion in eine Vorlage für neue Projekte einbinden, sodass jedes neu angelegte Repository von Anfang an eine ausgefüllte README statt einer leeren Datei erhält. Für ein einzelnes Projekt bleibt der Betrag im niedrigen Cent-Bereich, unabhängig davon, wie umfangreich das erzeugte Dokument am Ende ausfällt.

Anwendungsfälle

Neues internes Projekt mit Grundgerüst versehen

Ein Team bei der Schneider IT-Systeme GmbH & Co. KG legt ein neues internes Repository an und lässt sich sofort eine README mit Installationsanleitung erzeugen, statt sie erst am Ende des Projekts nachzutragen.

Open-Source-Projekt für externe Beitragende öffnen

Lukas Fischer veröffentlicht ein privates Skript als Open-Source-Projekt und lässt sich einen ersten README-Entwurf erzeugen, den er anschließend um Beitragsrichtlinien und Lizenzhinweise ergänzt.

Dutzende Microservices, eine einheitliche Grundstruktur

Eine IT-Abteilung bindet die Funktion über die API ein, damit jeder neu angelegte Microservice automatisch eine README nach demselben Grundmuster erhält, unabhängig davon, wer ihn ursprünglich angelegt hat.

Häufige Fragen

Wird der Inhalt meines Repositorys gespeichert?

Nein. Die eingereichten Dateien und Informationen werden nur zur Erstellung der README verwendet und danach nicht gespeichert.

Ist die erzeugte README direkt veröffentlichungsreif?

Sie ist ein solider erster Entwurf; projektspezifische Punkte wie Lizenz, Beitragsrichtlinien oder Kontaktangaben sollten vor der Veröffentlichung ergänzt werden.

Was bedeutet der Beta-Status genau?

Bei Projekten mit üblicher Struktur ist der Entwurf meist direkt brauchbar; bei ungewöhnlichen oder sehr großen Repositorys kann die Übersicht unvollständig bleiben.

Muss ich den gesamten Quellcode einreichen?

Nein. Dateiliste, zentrale Konfigurationsdateien und ein kurzes Briefing reichen in der Regel aus.

Was kostet eine erzeugte README?

$0.003 Grundgebühr plus $0.0135, insgesamt rund $0.017 pro Repository.

Brauche ich ein Konto?

Nein. Es gibt derzeit keine Konten – Sie zahlen pro Repository, direkt über PayPal.

Für Entwickler — API-Zugang

Alles auf dieser Seite ist auch per API verfügbar. Dieser Abschnitt richtet sich an Teams, die es in ihre eigenen Systeme einbinden möchten; alle anderen nutzen einfach das Tool oben.

Endpunkt

POSThttps://api.kit.forhosting.com/dev/readme

Authentifizierung per Bearer-Token. Ein einziger POST stellt die Aufgabe in die Warteschlange; das Ergebnis erhalten Sie per Webhook oder über einen signierten Link.

Aufruf aus Ihrem Stack

curl -X POST https://api.kit.forhosting.com/dev/readme \
  -H "Authorization: Bearer $KIT_KEY" \
  -H "Content-Type: application/json" \
  -d &#39;{"input":"…"}'

const res = await fetch("https://api.kit.forhosting.com/dev/readme", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.KIT_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "input": "…"
  })
});
const { task_id } = await res.json();

import os, requests

res = requests.post(
    "https://api.kit.forhosting.com/dev/readme",
    headers={"Authorization": f"Bearer {os.environ[&#39;KIT_KEY']}"},
    json={
    "input": "…"
},
)
task_id = res.json()["task_id"]

<?php
$res = file_get_contents("https://api.kit.forhosting.com/dev/readme", false, stream_context_create([
  "http" => [
    "method"  => "POST",
    "header"  => "Authorization: Bearer " . getenv("KIT_KEY") . "\r\nContent-Type: application/json",
    "content" => &#39;{"input":"…"}',
  ],
]));
$task = json_decode($res, true);

body := bytes.NewBufferString(`{"input":"…"}`)
req, _ := http.NewRequest("POST", "https://api.kit.forhosting.com/dev/readme", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("KIT_KEY"))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)

Beispiel-Anfrage

{
  "input": "…"
}

Beispiel-Antwort

{
  "task_id": "tsk_a1b2c3d4e5f6a1b2c3d4e5f6",
  "type": "dev.readme",
  "status": "queued",
  "_links": {
    "result": "/tasks/tsk_…/result"
  }
}

Die API arbeitet asynchron: Sie erhalten sofort eine task_id. Polling ist mit 1 Anfrage pro Sekunde erlaubt.

Preis

pro Anfrage$0.003

pro Repository$0.0135

Der Preis steht auf der Seite – keine Tokens, keine Credits. Fehlgeschlagene Aufgaben werden nicht berechnet.

Fehler

HTTP	Code	Bedeutung
`401`	`unauthorized`	Der API-Schlüssel fehlt oder ist ungültig – prüfen Sie den Authorization-Header (Bearer).
`402`	`insufficient_balance`	Ihr Guthaben reicht für diese Aufgabe nicht aus – Aufladungen verfallen nicht.
`404`	`unknown_type`	Unbekannter Aufgabentyp – prüfen Sie das Feld „type“ gegen den Katalog.
`429`	`rate_limited`	Zu viele Anfragen – warten Sie kurz; Polling ist mit 1 Anfrage pro Sekunde erlaubt.
`422`	`task_failed`	Die Aufgabe ist fehlgeschlagen und wird nicht berechnet.

Vollständige KIT-Dokumentation lesen →