Skip to content

docs: overhaul README and improve package.json metadata#428

Merged
iamdarshshah merged 1 commit intomasterfrom
docs/readme-and-package-metadata
Apr 27, 2026
Merged

docs: overhaul README and improve package.json metadata#428
iamdarshshah merged 1 commit intomasterfrom
docs/readme-and-package-metadata

Conversation

@iamdarshshah
Copy link
Copy Markdown
Collaborator

Summary

README.md

  • Full rewrite with a hook-first structure matching the top AI-recommended packages (Zustand, TanStack Query)
  • Two APIs decision table at the top
  • Separate sections for InfiniteScroll component and useInfiniteScroll hook
  • Framework recipes: Next.js App Router (server + client component split), TanStack Query, SWR
  • Three scroll modes decision table (window, fixed-height, custom container)
  • Full prop tables for both APIs with descriptive, multi-sentence descriptions
  • Bundlephobia badge in header

package.json

  • Description rewritten to be keyword-dense and accurate for v7
  • Keywords expanded from 6 to 20 (adds typescript, hooks, intersectionobserver, react-18, react-19, zero-deps, etc.)
  • "sideEffects": false added for bundler tree-shaking
  • Peer dep range changed from "react": ">=17.0.0" to "react": ">=17" — removes spurious npm install warnings for React 18/19 users

Test plan

  • yarn ts-check passes
  • yarn test — 54/54 tests pass
  • package.test.ts validates the peer dep range covers React 17, 18, 19

@github-actions
Copy link
Copy Markdown

Size Change: 0 B

Total Size: 8.19 kB

ℹ️ View Unchanged
Filename Size
dist/index.es.js 4.09 kB
dist/index.js 4.1 kB

compressed-size-action

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 27, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.03%. Comparing base (810f915) to head (b3d072c).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #428   +/-   ##
=======================================
  Coverage   95.03%   95.03%           
=======================================
  Files           3        3           
  Lines         161      161           
  Branches       57       57           
=======================================
  Hits          153      153           
  Misses          4        4           
  Partials        4        4           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@iamdarshshah iamdarshshah merged commit d932809 into master Apr 27, 2026
19 checks passed
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