Skip to content

docs(readme): hero catchphrase + flash/SSR-mismatch lead#16

Merged
SutuSebastian merged 1 commit into
mainfrom
docs/readme-hero-catchphrase
Jul 6, 2026
Merged

docs(readme): hero catchphrase + flash/SSR-mismatch lead#16
SutuSebastian merged 1 commit into
mainfrom
docs/readme-hero-catchphrase

Conversation

@SutuSebastian

@SutuSebastian SutuSebastian commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Align the README opening with the new GitHub repo description + catchphrase.

  • Add hero line under the H1: Any store, any storage, one middleware — no flash.
  • Rewrite the opening paragraph to lead with the two chore(ci): bump actions/checkout from 4 to 7 #1 documented pains (hydrate flash + SSR mismatch — grounded in an OSS issue scan across zustand-persist / redux-persist / @tanstack/query-persist-client / pinia-plugin-persistedstate), then store-agnostic PersistableSource (TanStack first), composable backend × codec × source seams (swap without rewriting), the first-class hydration signal, and capability breadth (cross-tab, versioned migrations, encrypted/compressed, retry-on-quota) + framework adapters.

Docs-only (README opening). The size badge + TOC below are unchanged.

New hero line under the H1: "Any store, any storage, one middleware — no
flash." Rewrite the opening paragraph to lead with the two #1 documented
pains (hydrate flash + SSR mismatch — per OSS issue scan across
zustand/redux/query/pinia persist), then store-agnostic PersistableSource
(TanStack first), the composable backend × codec × source seams (swap
without rewriting), the hydration signal, and the capability breadth
(cross-tab, versioned migrations, encrypted/compressed, retry-on-quota) +
framework adapters. Aligns the README with the GitHub repo description.
@changeset-bot

changeset-bot Bot commented Jul 6, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: ed55760

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 29bc0dee-850b-4bc6-99e3-b05117ca4698

📥 Commits

Reviewing files that changed from the base of the PR and between 1452a1e and ed55760.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

The README's introductory paragraph was replaced with new copy describing the middleware as store-agnostic and storage-agnostic, highlighting hydration signaling, structural composition seams, cross-tab sync, migrations, and encrypted/compressed backend support.

Changes

README Tagline Update

Layer / File(s) Summary
Update tagline description
README.md
Replaced the prior hydration-aware middleware description with a new "Any store, any storage, one middleware — no flash" paragraph.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the docs-only README update and highlights the new hero catchphrase and flash/SSR-mismatch introduction.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-hero-catchphrase

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@SutuSebastian SutuSebastian merged commit 28c659e into main Jul 6, 2026
12 checks passed
@SutuSebastian SutuSebastian deleted the docs/readme-hero-catchphrase branch July 6, 2026 14:06
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