Skip to content

Commit 156bd96

Browse files
committed
docs: update installation
1 parent 31cd47a commit 156bd96

File tree

3 files changed

+22
-16
lines changed

3 files changed

+22
-16
lines changed

docs/react/installation.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,28 @@ You can install React Query via [NPM](https://npmjs.com),
77
or a good ol' `<script>` via
88
[unpkg.com](https://unpkg.com).
99

10+
> v5 is currently in alpha.
11+
1012
### NPM
1113

1214
```bash
13-
$ npm i @tanstack/react-query
15+
$ npm i @tanstack/react-query@alpha
1416
# or
15-
$ pnpm add @tanstack/react-query
17+
$ pnpm add @tanstack/react-query@alpha
1618
# or
17-
$ yarn add @tanstack/react-query
19+
$ yarn add @tanstack/react-query@alpha
1820
```
1921

20-
React Query is compatible with React v16.8+ and works with ReactDOM and React Native.
22+
React Query is compatible with React v18+ and works with ReactDOM and React Native.
2123

22-
> Wanna give it a spin before you download? Try out the [simple](/query/v4/docs/examples/react/simple) or [basic](/query/v4/docs/examples/react/basic) examples!
24+
> Wanna give it a spin before you download? Try out the [simple](../examples/react/simple) or [basic](../examples/react/basic) examples!
2325
2426
### CDN
2527

2628
If you're not using a module bundler or package manager we also have a global ("UMD") build hosted on the [unpkg.com](https://unpkg.com) CDN. Simply add the following `<script>` tag to the bottom of your HTML file:
2729

2830
```html
29-
<script src="https://unpkg.com/@tanstack/react-query@4/build/umd/index.production.js"></script>
31+
<script src="https://unpkg.com/@tanstack/react-query@alpha/build/umd/index.production.js"></script>
3032
```
3133

3234
Once you've added this you will have access to the `window.ReactQuery` object and its exports.
@@ -53,9 +55,9 @@ opera >= 70
5355
It is recommended to also use our [ESLint Plugin Query](./eslint/eslint-plugin-query) to help you catch bugs and inconsistencies while you code. You can install it via:
5456

5557
```bash
56-
$ npm i -D @tanstack/eslint-plugin-query
58+
$ npm i -D @tanstack/eslint-plugin-query@alpha
5759
# or
58-
$ pnpm add -D @tanstack/eslint-plugin-query
60+
$ pnpm add -D @tanstack/eslint-plugin-query@alpha
5961
# or
60-
$ yarn add -D @tanstack/eslint-plugin-query
62+
$ yarn add -D @tanstack/eslint-plugin-query@alpha
6163
```

docs/svelte/installation.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,16 @@ title: Installation
55

66
You can install Svelte Query via [NPM](https://npmjs.com).
77

8+
> v5 is currently in alpha.
9+
810
### NPM
911

1012
```bash
11-
$ npm i @tanstack/svelte-query
13+
$ npm i @tanstack/svelte-query@alpha
1214
# or
13-
$ pnpm add @tanstack/svelte-query
15+
$ pnpm add @tanstack/svelte-query@alpha
1416
# or
15-
$ yarn add @tanstack/svelte-query
17+
$ yarn add @tanstack/svelte-query@alpha
1618
```
1719

1820
> Wanna give it a spin before you download? Try out the [basic](/query/v4/docs/svelte/examples/svelte/basic) example!

docs/vue/installation.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,19 @@ title: Installation
55

66
You can install Vue Query via [NPM](https://npmjs.com).
77

8+
> v5 is currently in alpha.
9+
810
### NPM
911

1012
```bash
11-
$ npm i @tanstack/vue-query
13+
$ npm i @tanstack/vue-query@alpha
1214
# or
13-
$ pnpm add @tanstack/vue-query
15+
$ pnpm add @tanstack/vue-query@alpha
1416
# or
15-
$ yarn add @tanstack/vue-query
17+
$ yarn add @tanstack/vue-query@alpha
1618
```
1719

18-
> Wanna give it a spin before you download? Try out the [basic](/query/v4/docs/vue/examples/vue/basic) example!
20+
> Wanna give it a spin before you download? Try out the [basic](../examples/vue/basic) example!
1921
2022
Vue Query is compatible with Vue 2.x and 3.x
2123

0 commit comments

Comments
 (0)