docs: make the README answer the questions evaluators arrive with - #37
Merged
Conversation
Three gaps, all of them costing installs rather than stars. Badges: no version, size, CI or licence signal anywhere, so a visitor had to leave the page to learn whether the project was alive or how big it was. Deliberately no downloads badge — at current volume that number argues against the package, and a badge that reads "12/month" is worse than none. "Is this the right tool?": the honest scoping question. This reports coordinates and never touches pixels, which makes it the wrong choice for anyone wanting canvas export and the right one for anyone feeding an image pipeline. Saying so up front costs a few bad-fit installs and saves the good-fit ones from bouncing. CDN install: trying the thing required an npm install first. It does not any more. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.
P1, items 8, 12 and 13 of the discoverability plan.
What changed
Badges — version, gzipped size, types, CI, licence. There was previously no signal anywhere on the page that the project was alive, maintained, or small.
"Is this the right tool?" — a short scoping section placed before Installation. It says plainly that this reports coordinates and never touches pixels, which makes it the wrong choice for anyone wanting canvas export and the right one for anyone feeding an image pipeline. It also maps the two outputs onto where they actually get used (
object-position, imgixfp-x/fp-y, Cloudinary gravity, a server-side sharp crop).CDN install — trying the library required an npm install first. It no longer does.
Features — replaced "lightweight" and "works without external libraries" with the real number, 3.6 kB gzipped, and added the TypeScript and framework-agnostic points.
One deliberate omission
No downloads badge. At current volume that number argues against the package — a badge reading "12/month" is worse than no badge. Worth adding once it is a number worth showing.
Notes
npm run build.Unreleasedchangelog section was tidied after the merge — the four merged branches each appended to it, leaving a stray break mid-list.Verification
npm test(18 passing),lint:check,format:checkandtypes:checkall green.🤖 Generated with Claude Code