Skip to content

Commit ea67377

Browse files
authored
docs: add readme.md to react adapter
1 parent 69a7d72 commit ea67377

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

packages/react-query/README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<img src="https://static.scarf.sh/a.png?x-pxid=be2d8a11-9712-4c1d-9963-580b2d4fb133" />
2+
3+
![TanStack Query Header](https://github.com/TanStack/query/raw/beta/media/repo-header.png)
4+
5+
Hooks for fetching, caching and updating asynchronous data in React
6+
7+
<a href="https://twitter.com/intent/tweet?button_hashtag=TanStack" target="\_parent">
8+
<img alt="#TanStack" src="https://img.shields.io/twitter/url?color=%2308a0e9&label=%23TanStack&style=social&url=https%3A%2F%2Ftwitter.com%2Fintent%2Ftweet%3Fbutton_hashtag%3DTanStack">
9+
</a><a href="https://discord.com/invite/WrRKjPJ" target="\_parent">
10+
<img alt="" src="https://img.shields.io/badge/Discord-TanStack-%235865F2" />
11+
</a><a href="https://github.com/TanStack/query/actions?query=workflow%3A%22react-query+tests%22">
12+
<img src="https://github.com/TanStack/query/workflows/react-query%20tests/badge.svg" />
13+
</a><a href="https://www.npmjs.com/package/@tanstack/query-core" target="\_parent">
14+
<img alt="" src="https://img.shields.io/npm/dm/@tanstack/query-core.svg" />
15+
</a><a href="https://bundlephobia.com/package/@tanstack/react-query@latest" target="\_parent">
16+
<img alt="" src="https://badgen.net/bundlephobia/minzip/@tanstack/react-query" />
17+
</a><a href="#badge">
18+
<img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
19+
</a><a href="https://github.com/TanStack/query/discussions">
20+
<img alt="Join the discussion on Github" src="https://img.shields.io/badge/Github%20Discussions%20%26%20Support-Chat%20now!-blue" />
21+
</a><a href="https://bestofjs.org/projects/tanstack-query"><img alt="Best of JS" src="https://img.shields.io/endpoint?url=https://bestofjs-serverless.now.sh/api/project-badge?fullName=TanStack%2Fquery%26since=daily" /></a><a href="https://github.com/TanStack/query/" target="\_parent">
22+
<img alt="" src="https://img.shields.io/github/stars/TanStack/query.svg?style=social&label=Star" />
23+
</a><a href="https://twitter.com/tannerlinsley" target="\_parent">
24+
<img alt="" src="https://img.shields.io/twitter/follow/tannerlinsley.svg?style=social&label=Follow" />
25+
</a> <a href="https://gitpod.io/from-referrer/">
26+
<img src="https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod" alt="Gitpod Ready-to-Code"/>
27+
</a>
28+
29+
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)
30+
31+
## Visit [tanstack.com/query](https://tanstack.com/query) for docs, guides, API and more!
32+
33+
## Quick Features
34+
35+
- Transport/protocol/backend agnostic data fetching (REST, GraphQL, promises, whatever!)
36+
- Auto Caching + Refetching (stale-while-revalidate, Window Refocus, Polling/Realtime)
37+
- Parallel + Dependent Queries
38+
- Mutations + Reactive Query Refetching
39+
- Multi-layer Cache + Automatic Garbage Collection
40+
- Paginated + Cursor-based Queries
41+
- Load-More + Infinite Scroll Queries w/ Scroll Recovery
42+
- Request Cancellation
43+
- [React Suspense](https://reactjs.org/docs/concurrent-mode-suspense.html) + Fetch-As-You-Render Query Prefetching
44+
- Dedicated Devtools
45+
- <a href="https://bundlephobia.com/package/@tanstack/react-query@latest" target="\_parent">
46+
<img alt="" src="https://badgen.net/bundlephobia/minzip/@tanstack/react-query" />
47+
</a> (depending on features imported)
48+
49+
### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/)
50+
51+
<!-- Use the force, Luke -->

0 commit comments

Comments
 (0)