Skip to content

docs: refresh README accuracy#16

Open
mohosin2126 wants to merge 1 commit into
yeasin2002:mainfrom
mohosin2126:docs/readme-refresh
Open

docs: refresh README accuracy#16
mohosin2126 wants to merge 1 commit into
yeasin2002:mainfrom
mohosin2126:docs/readme-refresh

Conversation

@mohosin2126
Copy link
Copy Markdown

Summary

This PR refreshes the README to better match the current state of the repository.

What changed

  • Updated repository links to yeasin2002/bulletproof-nextjs-starter
  • Updated the clone command and project directory name
  • Removed the broken npm run setup flow from Quick Start and Available Scripts
  • Added pnpm install as the recommended install path
  • Updated the project structure section to match the actual repository layout
  • Adjusted authentication/testing wording so it reflects the current starter/scaffolding state more accurately

Why

The previous README still referenced:

  • the old repository name and links
  • a setup script that does not exist
  • an outdated project structure
  • auth wording that implied more implementation than is currently wired in the app

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