Repository navigation
docs: refresh readme, package metadata and version header for 2.0.0 - #116
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ers need Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Collaborator
Author
|
hsd review round 1 Verdict: approve. This covers every item in #108:
Verified in the dev container (
Non-blocking nits:
|
Collaborator
Author
|
hsd: ready for human review after 1 review round(s). Agent sessions are still live in |
cesutherland
approved these changes
Oct 30, 2026
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.
Closes #108
Summary
js/license.jsno longer hard-codes1.0.3;make/build.jswrites// js-imagediff <package.json version>as the first line ofimagediff.jsandimagediff.min.js. A newspec/VersionSpec.jschecks that header when the specs run against a built file (npm run test:built, sonpm run releaseandnpm publish), keeping it in step withpackage.json.^18.12.0 || >=20.9.0) and node-canvas 3 install notes (prebuilt binaries, Cairo only when building from source);npm install imagediff/requireusage; CLI long flags and exit status; Jasmine 2+ matcher snippet with an exampleexpect; demo link moved togithub.io(thegithub.comPages domain no longer resolves); HUSL link → HSLuv; typo fix.filesallowlist —imagediff.js,imagediff.min.js,js/imagediff.js(the CLI requires it),bin/,browser/.npm pack --dry-runnow lists 8 files: those plus LICENSE, README.md, package.json.license: MIT,bugs, httpsrepositoryURL, andhomepage→ the GitHub README.<h3>HTML headings, which broke the list rendering, with Markdown headings.Decisions
imagediff.jskeeps its1.0.3header until the release PR runsnpm run release, and the new spec makes that run fail if the header doesn't match. I checked this locally:npm run releasepasses and both headers read2.0.0-alpha.1. I then reverted the built files.package.jsonstays at2.0.0-alpha.1. Bumping to2.0.0belongs to the release step, and the changelog entry is already headed 2.0.0.humblesoftware.github.io/js-imagediff/test.htmlstill uses Jasmine 1 (this.addMatchers). The README now links only the main demo andexamples/. Updating the gh-pages branch is out of scope.bower.jsondeletion ended up in the first commit (build: stamp the package version…) instead of the metadata commit. I didn't rewrite the pushed history to move it.Testing
In the dev container:
npm testpasses (44 Node specs, 39 browser specs), andnpm run releasepasses against both built files (45 Node specs, including the header check).🤖 Generated with Claude Code