Repository navigation
docs(readme): rewrite in plain language and add a quick start - #59
Merged
Merged
Conversation
Drops the em-dashes and the "not X, but Y" phrasing, and tones down the pitch-style lines. The new Quick start shows npx, pnpm dlx and bunx side by side, plus common variations: non-interactive, --pm, --dry-run, --disable, the next dist-tag and a global install. Every flag shown is documented in docs/commands.md. The opening line no longer promises auth and a database, which nuxt4-minimal does not have.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this changes
Rewrites
README.mdin plain language: no em-dashes, no "not X, but Y" constructions, less pitch. Adds an Updating plugins block (plugin outdated,plugin update,plugin auto-update) under Installing and updating. Adds a Quick start section withnpx,pnpm dlxandbunxside by side, plus common variations: non-interactive--yes,nuxt4-minimalwithout Docker,--pm,--dry-run,--disable,@nextand a global install.Why
The README read like marketing copy, and
pnpm dlxandbunxonly appeared in passing in a later section.Type of change
AI assistance
Agent, service and model, if you know it: Claude Code, Opus 5.5
How much of this is agent-written?
Feature versions
Testing
README only. Every flag in Quick start is documented in
docs/commands.md. Every fact from the old README is kept except two removed sentences: the health check's "not a fixed 200" line and the ".env has no leftover placeholders" line.Checklist
Anything else
Section renames: "What you can do with it" is now "Features", "When something goes wrong" is now "Troubleshooting", "Built for an AI to pick up on day one" is now "Ready for AI coding agents", "Shaped for deployment, not just a demo" is now "Deployment", and "Parts and components" is now "Packages". Nothing in
docs/links to those anchors.