docs: add a README to @relkit/cli

Offen Anfängerfreundlich
  • Stimmt etwas nicht?
#176 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
1/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
90/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
bun, typescript
Bereich
documentation

Rechercherichtung

Lies WRITING.md und orientiere dich an packages/relkit/README.md. Füge packages/cli/README.md hinzu, das den relkit-Befehl und seine Befehle dev, check, build, add, deploy, migrate und mcp, die Installation sowie den Link zur CLI-Referenz beschreibt. Führe bun run check aus; fertig ist die Arbeit, wenn der Check besteht und die README nach der Veröffentlichung auf npm korrekt dargestellt wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

documentation good first issue

packages/cli has no README.md, so the package page on npm is empty.

What to do

  • Add packages/cli/README.md with: what @relkit/cli is (the relkit command: dev, check,
    build, add, deploy, migrate, mcp), how to install it, and a link to the
    CLI reference.
  • Use the product name RelKit in prose and follow WRITING.md.

Done when bun run check passes and the README renders on the package page after the next
release. packages/relkit/README.md is a good model.

Vorherrschende Sprache
TypeScript
Sterne
1
Forks
0
Ø Merge
6 Std. 18 Min.
Gemergte PRs (30 T.)
55

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus rel-kit/relkit

Alle Issues in rel-kit/relkit

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.