Skip to content

Commit 532d085

Browse files
authored
Update README.md
1 parent 2f694d4 commit 532d085

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,36 @@
1-
# @ryfylke-react/rtk-query-loader
2-
31
![ryfrea-rtk-query-loader](https://user-images.githubusercontent.com/1190770/233955284-a7da801e-ff3f-4fdc-9808-8f1e5a829012.png)
42

53
![npm](https://img.shields.io/npm/v/@ryfylke-react/rtk-query-loader?color=gray&style=flat-square)
64
![npm type definitions](https://img.shields.io/npm/types/@ryfylke-react/rtk-query-loader?color=gray&label=%20&logoColor=gray)
75
![npm bundle size](https://img.shields.io/bundlephobia/min/@ryfylke-react/rtk-query-loader@latest?style=flat-square)
86

9-
Lets you create loaders that contain multiple RTK queries.
7+
RTK Query Loader lets you create query loaders for your React components.
8+
9+
> Made for use with RTK Query, but can also be used with React Query and more.
1010
1111
- [Live demo / Playground](https://codesandbox.io/s/rtk-query-loader-demo-42tubp)
1212
- [NPM](https://www.npmjs.com/package/@ryfylke-react/rtk-query-loader)
1313
- [Documentation](https://rtk-query-loader.ryfylke.dev/)
1414
- [Quick Start](https://rtk-query-loader.ryfylke.dev/Quick%20Guide/)
1515

16-
## **Usage**
16+
## Install
1717

1818
```bash
1919
yarn add @ryfylke-react/rtk-query-loader
2020
# or
2121
npm i @ryfylke-react/rtk-query-loader
2222
```
2323

24+
## Features
25+
26+
- [x] **Flexible**: You can extend and inherit existing loaders to create new ones.
27+
- [x] **Transformable**: Combine and transform the data from your loaders to your desired format.
28+
- [x] **Query Agnostic**: Can be used with RTK Query, Tanstack Query, JS promises, [and more...](https://rtk-query-loader.ryfylke.dev/Features/other-libs)
29+
- [x] **Configurable**: Exposes important configuration options, all of which are inheritable.
30+
31+
You can read more about the features @ [the docs](https://rtk-query-loader.ryfylke.dev/Features/).
32+
33+
## Example
2434
A simple example of a component using rtk-query-loader:
2535

2636
```tsx

0 commit comments

Comments
 (0)