docs: expand package READMEs with usage, API, and examples#92
Merged
lukascivil merged 2 commits intomasterfrom Apr 22, 2026
Merged
docs: expand package READMEs with usage, API, and examples#92lukascivil merged 2 commits intomasterfrom
lukascivil merged 2 commits intomasterfrom
Conversation
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
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.
Objective
The package-level READMEs were either missing or one-liner stubs, leaving npm visitors and new contributors without enough context to install, run, or wire each package into a project. This rewrites them so each package is self-explanatory from its own README.
What was done
libs/json-differencecovering install, usage, full API reference (getDiff,getStructPaths,getEditedPaths,getPathsDiff), theDeltashape, options, path format, a reference-operations table, and CDN usagelibs/json-difference-cliwith install,jd -o … -m …usage, options table, examples, shell-quoting tips for macOS/Linux/PowerShell, and output formattools/mcp-json-diff/README.md: split capabilities into Tools vs. Prompts sections, added Why/Requirements, Claude Desktop and Claude Code setup (with config paths per OS), inspector instructions, troubleshooting table, log locations, and a Development sectionapps/example/README.mdto documentsrc/simple.tsandsrc/stress.ts, how to run vianxortsxdirectly, expected output, and how to add a new caseapps/playground/README.mdwith the live demo link, stack (React 19, Chakra UI v3, Monaco, Vite), local dev / build / preview / lint / type-check commands, and a deployment note pointing at the CD workflowTest plan
json-difference,json-difference-cli) will display the new READMEs correctly (no broken relative links to monorepo paths that don't ship in the npm tarball)