Skip to content

docs: rewrite README with accurate info and cleaner structure#5675

Open
nimrodkra wants to merge 1 commit intomainfrom
nimrod/improve-readme
Open

docs: rewrite README with accurate info and cleaner structure#5675
nimrodkra wants to merge 1 commit intomainfrom
nimrod/improve-readme

Conversation

@nimrodkra
Copy link
Member

@nimrodkra nimrodkra commented Mar 8, 2026

Summary

  • Fixed stale info: Node version (22.11 -> 22.22), master -> main branch refs, npm -> pnpm commands
  • Restructured into a single getting-started flow instead of separate "Local Environment" and "Bootstrap Project" sections
  • Added tech stack listing, packages as a table, link to the live product

Test plan

  • Verify markdown renders correctly on GitHub
  • Confirm all relative package links resolve
  • Confirm badge images load

Made with Cursor

Preview domain

https://nimrod-improve-readme.preview.app.daily.dev

The old README had stale Node version (22.11 vs 22.22), master branch
refs that should be main, npm commands instead of pnpm, and a confusing
split between "Local Environment" and "Bootstrap Project" sections.

Rewrote it: single getting-started flow, packages as a table, actual
tech stack listed, all links fixed.

Made-with: Cursor
@vercel
Copy link

vercel bot commented Mar 8, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
daily-webapp Ready Ready Preview Mar 8, 2026 8:51am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
storybook Ignored Ignored Mar 8, 2026 8:51am

Request Review

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.

1 participant