diff --git a/README.md b/README.md index 3f4fa2bd4f..47839f688e 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,59 @@ -![TanStack Query Header](https://github.com/TanStack/query/raw/main/media/repo-header.png) - -Hooks for fetching, caching and updating asynchronous data in React, Solid, Svelte and Vue - - - #TanStack - - - - - - - - semantic-release - - Join the discussion on Github -Best of JS - - - - - Gitpod Ready-to-Code +
+ TanStack Query +
+ +An async state management library built to simplify fetching, caching, synchronizing, and updating server state. + +- Protocol‑agnostic fetching (REST, GraphQL, promises, etc.) +- Caching, refetching, pagination & infinite scroll +- Mutations, dependent queries & background updates +- Prefetching, cancellation & React Suspense support + +
Read the Query Docs → +
+ +
+ +
+ + + + + + + + +
+ +
+ + semantic-release + +Best of JS + Follow @TanStack +
+ +
-Enjoy this library? Try the entire [TanStack](https://tanstack.com)! [TanStack Table](https://github.com/TanStack/table), [TanStack Router](https://github.com/tanstack/router), [TanStack Virtual](https://github.com/tanstack/virtual), [React Charts](https://github.com/TanStack/react-charts), [React Ranger](https://github.com/TanStack/ranger) +[Become a Sponsor!](https://github.com/sponsors/tannerlinsley/) -## Visit [tanstack.com/query](https://tanstack.com/query) for docs, guides, API and more! +
-Still on **React Query v2**? No problem! Check out the v2 docs here: https://github.com/TanStack/query/tree/2.x/docs/src/pages/docs.
-Still on **React Query v3**? No problem! Check out the v3 docs here: https://tanstack.com/query/v3/docs/.
-Still on **React Query v4**? No problem! Check out the v4 docs here: https://tanstack.com/query/v4/docs/. +
-## Quick Features +## Get Involved -- Transport/protocol/backend agnostic data fetching (REST, GraphQL, promises, whatever!) -- Auto Caching + Refetching (stale-while-revalidate, Window Refocus, Polling/Realtime) -- Parallel + Dependent Queries -- Mutations + Reactive Query Refetching -- Multi-layer Cache + Automatic Garbage Collection -- Paginated + Cursor-based Queries -- Load-More + Infinite Scroll Queries w/ Scroll Recovery -- Request Cancellation -- [React Suspense](https://react.dev/reference/react/Suspense) + Fetch-As-You-Render Query Prefetching -- Dedicated Devtools +- We welcome issues and pull requests! +- Participate in [GitHub discussions](https://github.com/TanStack/query/discussions) +- Chat with the community on [Discord](https://discord.com/invite/WrRKjPJ) +- See [CONTRIBUTING.md](./CONTRIBUTING.md) for setup instructions ## Partners +
+
-## Contributing - -View the contributing guidelines [here](/CONTRIBUTING.md) +## Explore the TanStack Ecosystem -### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/) +
+TanStack Config – Tooling for JS/TS packages
+ TanStack DB – Reactive sync client store
+ TanStack DevTools – Unified devtools panel
+ TanStack Form – Type‑safe form state
+ TanStack Pacer – Debouncing, throttling, batching
+ TanStack Ranger – Range & slider primitives
+ TanStack Router – Type‑safe routing, caching & URL state
+ TanStack Start – Full‑stack SSR & streaming
+ TanStack Store – Reactive data store
+ TanStack Table – Headless datagrids
+ TanStack Virtual – Virtualized rendering
+ … and more at TanStack.com » +
diff --git a/media/header_query.png b/media/header_query.png new file mode 100644 index 0000000000..96fe6e78fa Binary files /dev/null and b/media/header_query.png differ