Skip to content

docs: add a 2-minute hello scaffold to the README - #229

Draft
KeKs0r wants to merge 1 commit into
mainfrom
cursor/readme-get-started-1317
Draft

KeKs0r wants to merge 1 commit into
mainfrom
cursor/readme-get-started-1317

Conversation

@KeKs0r

@KeKs0r KeKs0r commented Sep 29, 2026

Copy link
Copy Markdown
Member

Summary

  • Root README now opens with Get started in 2 minutes (after the blurb, badges, and beta note, before Why chkit and the longer API-sync walkthrough): bun create chkit@latest my-app --example hello, migrate, and the users / events query. The old one-line scaffold pointer is folded into that section.
  • packages/create-chkit/README.md lists hello as the default example (two small tables, one migration) and clickbench, and the pick-by-name snippet uses --example hello, matching the published 0.2.0-beta.8 manifest.

Test plan

  • Read the root README top to bottom and confirm order: intro, Get started in 2 minutes, Why chkit, From a schema to a working sync.
  • Confirm the create-chkit Examples table names hello as default and still documents clickbench.
Open in Web Open in Cursor 

Put the default hello example first, and list hello plus clickbench in the create-chkit README so it matches the published beta.8 manifest.

Co-authored-by: Marc Höffl <marc.hoeffl@gmail.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants