docs: put name-claiming front and center; ship a README with the placeholder - #18
Merged
Merged
Conversation
…eholder - README leads with a 'Just claim a name' section right under the demo: `npx fledgling add <name> --new --yes` from any directory, plus the --skip-trust variant for in-repo claims. Intro now lists claiming and trusted-publishing sync as two separately usable jobs. - The placeholder published to claim a name now includes a README.md saying the name was claimed with fledgling (linked), linking the package's own repo/homepage when the manifest has one, and pointing readers at the same one-liner.
|
The changes in this PR will be included in the next version bump.
|
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.
Summary
npm login+npx fledgling add <name> --new --yesfrom any directory, plus the--skip-trustvariant for claiming everything in an existing repo. The intro paragraph lists name-claiming and trusted-publishing sync as two jobs you can use independently, and the buried "Just want to claim names?" subsection now links up to the new section.README.md(alongside thepackage.json) so the npm page says what it is: claimed with fledgling (linked), links the package's own repo/homepage when the manifest has one, notes there's nothing to install yet, and closes with the same one-liner.Test plan
bun run typecheckandbun run buildpassplaceholderReadme()for a bare name and for a manifest withrepository; both read correctly--new --yesand confirm the README shows on npmjs.com