Repository navigation
Ship the root README to npm instead of a hand-kept copy - #198
Merged
Merged
Conversation
1 of 3 tasks
devmaxxx
added a commit
that referenced
this pull request
Oct 17, 2026
* chore(release): bump to 0.6.2 Ships the root README to npm (#198); the binary is unchanged. * docs(readme): drop the from-source install line The README is now the npm page too, where a source checkout is not what the reader has; docs/install.md keeps the source route. * docs(readme): add a step-by-step project setup The README is the npm page now, so the first thing a reader there needs is how to wire zerograph into their own repository: ignore the store, build, ask, connect the agent, and where the config lives. * docs(readme): fold the project setup into one command block
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
The npm page showed
npm/zerograph/README.md, a short copy last changed in #187, so the badges, navigation and comparison image from #188 never reached npm.scripts/npm-pack.shnow cuts the package README from the rootREADME.mdat pack time and pins each relative path to the version tag: images go toraw.githubusercontent.com, links togithub.com/.../blob/vX.Y.Z/. The hand-kept copy is untracked and gitignored.npm only refreshes a README on publish, so the page changes with the next release.
Test plan
scripts/npm-pack.sh 9.9.9: the packed README is the root one, with no relative](...)left and the comparison image on a raw URLnode --test npm/zerograph/test/launcher.test.js: 9 pass