KI-README-Generator
Grobe Projektnotizen rein, eine vollständige README.md mit Installation, Nutzung und Optionstabelle raus.
Ihr Key bleibt in Ihrem Browser.Er geht direkt an den Anbieter, nie an unsere Server, und wir protokollieren oder speichern ihn nicht. Verwenden Sie einen eigenen Key mit Ausgabenlimit und löschen Sie ihn nach der Nutzung im Dashboard des Anbieters.
Eingabe
Ergebnis
Das Ergebnis erscheint hier.Die meisten Projekte erscheinen mit einer README, in der „TODO“ steht. Fügen Sie ein, was Sie haben – eine Beschreibung in einer Zeile, Ihre package.json, die --help-Ausgabe der CLI, eine Liste von Befehlen – und erhalten Sie eine vollständige README.md: Titel und Tagline, Badges, Features, Voraussetzungen, Installation, Nutzung mit kopierbarem Beispiel, Optionstabelle, Entwicklung, Mitwirken und Lizenz. Die Reihenfolge der Abschnitte folgt kefranabg/readme-md-generator, der beliebten CLI zum Erstellen von READMEs; der Unterschied ist, dass Sie deren Fragen nicht einzeln beantworten müssen.
So arbeitet es
- Alles, was die Notizen nicht angeben – eine Repository-URL, eine Version, die Lizenz –, wird zu einem sichtbaren <!-- TODO -->-Platzhalter statt zu einer erfundenen Tatsache.
- Flags, Optionen und Umgebungsvariablen aus Ihren Notizen werden zu einer Tabelle mit den Spalten Option, Standardwert und Beschreibung.
- Schreiben Sie die Notizen auf Deutsch oder Chinesisch und bestellen Sie trotzdem eine englische README, oder umgekehrt; Befehle und Code werden nie übersetzt.
Wohin Ihre Daten gehen
Mit eigenem Key gehen Ihre Eingabe und der Key direkt von Ihrem Browser zum gewählten Anbieter, ohne Umweg über Hysen Labs. Im gehosteten Modus läuft Ihr Text über unseren Server zu unserem Anbieter (DeepSeek) und wird in Credits abgerechnet; zur Abrechnung speichern wir Token-Zahlen und Kosten jedes Laufs, nie den Text selbst oder die Antwort. Wie der Anbieter mit dem Text umgeht, regelt dessen eigene Datenschutzerklärung.
Dieses Werkzeug verarbeitet Schlüssel und Zugangsdaten. Zu einem Lauf wird deshalb nichts gespeichert, auch nicht in Ihrem eigenen Verlauf.
Zu Ihrem API-Key
Wir erheben, speichern und geben Ihren Key nicht weiter: Er liegt nur im Arbeitsspeicher dieser Seite (außer Sie wählen „in diesem Tab merken“) und ist nach dem Schließen verschwunden. Trotzdem gilt für jeden Key, der in eine Webseite eingefügt wurde, besondere Sorgfalt – legen Sie für diesen Zweck einen eigenen Key mit Ausgabenlimit an und löschen oder rotieren Sie ihn nach der Nutzung im Dashboard des Anbieters.
Was es kostet
Dieses Werkzeug ist kostenlos, ohne Anmeldung und ohne Punkte.
Häufige Fragen
- Erfindet es Features oder Badges?
- Es ist angewiesen, das nicht zu tun, und fehlende Fakten bleiben Platzhalter. Badges werden nur für Dinge ergänzt, die Ihre Notizen belegen, etwa einen npm-Paketnamen oder eine Lizenz, und nutzen shields.io-URLs; schalten Sie Badges ab, wenn Sie keine möchten.
- Was sollte ich für das beste Ergebnis einfügen?
- Das Paketmanifest (package.json, pyproject.toml oder Cargo.toml), die --help-Ausgabe und einen Satz dazu, für wen das Projekt gedacht ist. Echte Flag-Namen und Installationsbefehle ergeben eine README, die nicht nur ordentlich, sondern auch korrekt ist.
- Wohin gehen meine Notizen und mein Key?
- Direkt von dieser Seite zum gewählten KI-Anbieter, mit Ihrem Key; hysenlabs.com speichert nichts. Für ein unveröffentlichtes Projekt nutzen Sie einen Anbieter, dessen Bedingungen Sie akzeptieren, und einen eigens dafür erstellten Key, den Sie danach entfernen.
Das Open Source dahinter
Dieses Werkzeug ist eine eigenständige Implementierung ohne fremde Bibliothek. kefranabg/readme-md-generator (MIT) erledigt dieselbe Aufgabe als Bibliothek — wer sie im eigenen Programm braucht, fängt dort an, statt eine Webseite aufzurufen.
kefranabg/readme-md-generatorAuch bekannt als
- readme generator
- readme erstellen
- readme.md vorlage
- github readme generator
- ki readme schreiben