Skip to content

Commit 55919b5

Browse files
authored
docs: update the documentation page. (#73)
1 parent eb149c0 commit 55919b5

5 files changed

Lines changed: 467 additions & 93 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**A reactive client store for building super fast apps on sync**
66

7-
TanStack DB extends TanStack Query with collections, live queries and transactional mutations that keep your UI reactive, consistent and blazing fast 🔥
7+
TanStack DB extends TanStack Query with collections, live queries and optimistic mutations that keep your UI reactive, consistent and blazing fast 🔥
88

99
<p>
1010
<a href="https://x.com/intent/post?text=TanStack%20DB&url=https://tanstack.com/db">
@@ -50,7 +50,7 @@ Sync data into collections:
5050
```ts
5151
import { createQueryCollection } from "@tanstack/db-collections"
5252

53-
const todoCollection = createQueryCollection<TodoList>({
53+
const todoCollection = createQueryCollection<Todo>({
5454
queryKey: ["todos"],
5555
queryFn: async () => fetch("/api/todos"),
5656
getId: (item) => item.id,
@@ -121,15 +121,15 @@ There's also an example [React todo app](./examples/react/todo) and usage exampl
121121
- typed sets of objects that can mirror a backend table or be populated with a filtered view or result set, such as `pendingTodos` or `decemberNewTodos`
122122
- collections are just JavaScript data &mdash; load them on demand and define as many as you need
123123

124-
### Live Queries
124+
### Live queries
125125

126126
- run reactively against and across collections with support for joins, filters and aggregates
127127
- powered by differential dataflow: query results update incrementally, not by re-running the whole query
128128

129-
### Transactions
129+
### Transactional mutators
130130

131131
- batch and stage local changes across collections with immediate application of local optimistic updates
132-
- sync to the backend using flexible mutationFns with automatic rollbacks and management of optimistic state
132+
- sync transactions to the backend with automatic rollbacks and management of optimistic state
133133

134134
## 🔧 Install
135135

0 commit comments

Comments
 (0)