Commit 66603d7
Update overview w/ Query-Driven Sync and other features/arguments (#812)
* Enhance overview.md with blog post content and Query-Driven Sync
Updates the overview documentation to better reflect the content and
features from the two DB blog posts (0.1 and 0.5):
- Add compelling "Option C" narrative explaining the architecture
problem TanStack DB solves (view-specific APIs vs load-everything)
- Document Query-Driven Sync feature from 0.5 release:
- Three sync modes: eager, on-demand, progressive
- How component queries automatically become API calls
- Request optimization (collapsing, delta loading, join batching)
- Add concrete performance numbers: ~0.7ms updates for 100k items
on M1 Pro, demonstrating truly instantaneous optimistic updates
- Expand sync engine benefits section:
- Easy real-time updates without WebSocket plumbing
- Automatic side-effects and cache invalidation
- Efficient delta updates enabling "load everything once" pattern
These changes bridge the gap between the technical reference docs
and the compelling narrative from the blog posts, helping developers
understand both why TanStack DB exists and how to use it effectively.
* Add end-user benefit emphasis: apps stay fast regardless of data size
Highlights that apps can't get sluggish due to too much data, with
queries over 100k+ rows completing in under a millisecond. This makes
the end-user experience benefit clear early in the documentation.
* Refine introduction with clearer problem-solution framing
Rewrites the introduction to:
- Lead with the problems TanStack DB solves (endpoint sprawl,
client performance, network on interaction path)
- Emphasize the end-user benefit upfront: interactions feel
instantaneous, app stays fast regardless of data volume
- Present the "new way" as numbered benefits rather than
"Option C" framing
- More action-oriented and benefit-focused language
This makes the value proposition clearer and more compelling
for developers evaluating TanStack DB.
* Update README.md to match new overview.md messaging
Aligns README with the refined overview.md framing:
- Changes "client-first" to "client" to match new terminology
- Adopts problem-solution framing (avoid endpoint sprawl,
optimize client performance, take network off interaction path)
- Emphasizes end-user benefit: app stays fast regardless of data
- More action-oriented and benefit-focused language
Keeps README concise while maintaining consistency with docs.
* Update packages/db/README.md with new messaging
Aligns the core package README with the refined messaging:
- Updates tagline to "The reactive client store for your API"
- Adds "solves the problems of building fast, modern apps"
- Rewrites bullet points to focus on problem-solution framing:
- Avoid endpoint sprawl (vs building custom endpoints)
- Blazing fast queries (app stays fast regardless of data)
- Instant interactions (network off interaction path)
- Fine-grained reactivity (minimize re-rendering)
Makes the npm package description more benefit-oriented.
---------
Co-authored-by: Claude <[email protected]>1 parent 44b5877 commit 66603d7
3 files changed
+80
-18
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
37 | 37 | | |
38 | 38 | | |
39 | 39 | | |
40 | | - | |
| 40 | + | |
41 | 41 | | |
42 | | - | |
| 42 | + | |
43 | 43 | | |
44 | | - | |
45 | | - | |
46 | | - | |
47 | | - | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
48 | 49 | | |
49 | 50 | | |
50 | 51 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
10 | | - | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
11 | 32 | | |
12 | 33 | | |
13 | 34 | | |
| |||
71 | 92 | | |
72 | 93 | | |
73 | 94 | | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
74 | 123 | | |
75 | 124 | | |
76 | 125 | | |
77 | 126 | | |
78 | | - | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
79 | 130 | | |
80 | 131 | | |
81 | 132 | | |
| |||
412 | 463 | | |
413 | 464 | | |
414 | 465 | | |
| 466 | + | |
| 467 | + | |
| 468 | + | |
| 469 | + | |
| 470 | + | |
| 471 | + | |
| 472 | + | |
| 473 | + | |
| 474 | + | |
| 475 | + | |
415 | 476 | | |
416 | 477 | | |
417 | 478 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
24 | | - | |
25 | | - | |
26 | | - | |
27 | | - | |
28 | | - | |
29 | | - | |
30 | | - | |
31 | | - | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
| |||
0 commit comments