docs(readme): lead with the problem, add badges and instant-try command#146
Merged
Conversation
Sharpen the top of the README (the project's landing page): open with the concrete failure mode (CMS/route drift) and what cms-lab catches, list the supported adapters, show the no-install npx command immediately, and add npm/CI/license badges for credibility.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
Tightens the top of the README (the landing page that launch traffic hits): leads with the concrete CMS/route-drift failure mode and what cms-lab catches, lists supported adapters, shows the no-install
npx @cms-lab/cli scancommand immediately, and adds npm/CI/license badges. Docs only; pnpm format:check green.