docs(readme): fix inaccuracies, improve layout and add quick reference table

[michaeljymsgutierrez]

Description

The README had accumulated several inaccuracies, stale wording, and inconsistent formatting since string ID support was added in v2.9.0. This PR fixes all known inaccuracies, improves the layout and heading structure, and adds a Quick Reference table covering all 22 public methods.

Github Issue: N/A

Changes

Accuracy fixes

• destroyRecord HTTP method label corrected from GET to DELETE
• groupBy description updated - removed stale "Incorrectly uses uniqBy" note; function works correctly
• id parameter type updated from Number to Number | String to reflect string ID support added in v2.9.0
• getAlias parameter name corrected from collectionFallbackRecord to fallbackRecords to match actual method signature
• queryRecord params argument marked as optional instead of required
• Added missing demo links for getAlias and getRequestAlias
• MobX named explicitly instead of "likely through a library like Mobx"

Layout and formatting

• Added Quick Reference table after the Overview section listing all 22 public methods with descriptions
• Fixed heading hierarchy throughout - #### headings under ## sections promoted to ###
• Collection Records section elevated to top-level ##
• State Properties, Getter and Setter Functions, Request and Retrieve Functions converted from bold bullet items to proper ### subheadings
• Removed inconsistent --- horizontal rules after headings
• Removed backticks from heading text
• Standardized "See example here" link placement to immediately follow the method signature line
• Added parameter table for getCollection
• TOC updated to reflect new heading structure
• Wording improved throughout for clarity and consistency

Screenshots/Images

N/A - documentation only.

How Has This Been Tested?

• Manually reviewed all changed sections for accuracy against the source code
• Verified all demo links point to existing pages in apps/create-next-app/
• No code changes - documentation only

Checklist

• Code follows the project's coding standards and best practices.
• Tests are written for new functionality and existing tests pass.
• Documentation is updated to reflect changes.
• The PR is assigned to the correct reviewers.

Reviewer Guidance

• Two commits: first fixes inaccuracies and adds missing demo links; second applies the full layout overhaul
• No functional changes - this is purely documentation
• The id - Number | String change is the most important accuracy fix - reflects the v2.9.0 feature that went in without a docs update

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
arm-js-library-demo	Ready	Preview, Comment	Jul 3, 2026 12:46am