Skip to content

docs: make the README answer the questions evaluators arrive with - #37

Merged
killerwolf merged 3 commits into
mainfrom
docs/readme-conversion
Sep 6, 2026
Merged

docs: make the README answer the questions evaluators arrive with#37
killerwolf merged 3 commits into
mainfrom
docs/readme-conversion

Conversation

@killerwolf

Copy link
Copy Markdown
Owner

P1, items 8, 12 and 13 of the discoverability plan.

Replaces #35, which GitHub auto-closed when its base branch (feat/typescript-declarations, now merged as #33) was deleted. Same branch, same commits, retargeted at main with the other merged work folded in.

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, imgix fp-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

  • The 3.6 kB figure is the minified UMD build gzipped, measured from a local npm run build.
  • Badge and CDN URLs were all checked for a 200 before being committed. The bare jsDelivr URL does resolve to the UMD build, but the README recommends the explicit pinned path.
  • The Unreleased changelog 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:check and types:check all green.

🤖 Generated with Claude Code

killerwolf and others added 3 commits September 6, 2026 09:49
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>
@killerwolf
killerwolf merged commit e4de84c into main Sep 6, 2026
2 checks passed
@killerwolf
killerwolf deleted the docs/readme-conversion branch September 6, 2026 08:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant