Skip to content

Commit

Permalink
docs: Updated installation commands with bun package manger (#6971)
Browse files Browse the repository at this point in the history
  • Loading branch information
ekamahuja committed Feb 25, 2024
1 parent ef3a0df commit d83aa27
Show file tree
Hide file tree
Showing 26 changed files with 62 additions and 19 deletions.
2 changes: 2 additions & 0 deletions docs/eslint/eslint-plugin-query.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ $ npm i -D @tanstack/eslint-plugin-query
$ pnpm add -D @tanstack/eslint-plugin-query
# or
$ yarn add -D @tanstack/eslint-plugin-query
# or
$ bun add -D @tanstack/eslint-plugin-query
```

## Usage
Expand Down
2 changes: 2 additions & 0 deletions docs/framework/angular/devtools.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ $ npm i @tanstack/angular-query-devtools-experimental
$ pnpm add @tanstack/angular-query-devtools-experimental
# or
$ yarn add @tanstack/angular-query-devtools-experimental
# or
$ bun add @tanstack/angular-query-devtools-experimental
```

You can import the devtools like this:
Expand Down
2 changes: 2 additions & 0 deletions docs/framework/angular/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ $ npm i @tanstack/angular-query-experimental
$ pnpm add @tanstack/angular-query-experimental
# or
$ yarn add @tanstack/angular-query-experimental
# or
$ bun add @tanstack/angular-query-experimental
```

> Wanna give it a spin before you download? Try out the [simple](./examples/simple) or [basic](./examples/basic) examples!
2 changes: 2 additions & 0 deletions docs/framework/react/devtools.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ $ npm i @tanstack/react-query-devtools
$ pnpm add @tanstack/react-query-devtools
# or
$ yarn add @tanstack/react-query-devtools
# or
$ bun add @tanstack/react-query-devtools
```

For Next 13+ App Dir you must install it as a dev dependency for it to work.
Expand Down
4 changes: 4 additions & 0 deletions docs/framework/react/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ $ npm i @tanstack/react-query
$ pnpm add @tanstack/react-query
# or
$ yarn add @tanstack/react-query
# or
$ bun add @tanstack/react-query
```

React Query is compatible with React v18+ and works with ReactDOM and React Native.
Expand Down Expand Up @@ -60,4 +62,6 @@ $ npm i -D @tanstack/eslint-plugin-query
$ pnpm add -D @tanstack/eslint-plugin-query
# or
$ yarn add -D @tanstack/eslint-plugin-query
# or
$ bun add -D @tanstack/eslint-plugin-query
```
6 changes: 6 additions & 0 deletions docs/framework/react/plugins/createAsyncStoragePersister.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ or
yarn add @tanstack/query-async-storage-persister @tanstack/react-query-persist-client
```

or

```bash
bun add @tanstack/query-async-storage-persister @tanstack/react-query-persist-client
```

## Usage

- Import the `createAsyncStoragePersister` function
Expand Down
6 changes: 6 additions & 0 deletions docs/framework/react/plugins/createPersister.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ or
yarn add @tanstack/query-persist-client-core
```

or

```bash
bun add @tanstack/query-persist-client-core
```

> Note: This util is also included in the `@tanstack/react-query-persist-client` package, so you do not need to install it separately if you are using that package.
## Usage
Expand Down
6 changes: 6 additions & 0 deletions docs/framework/react/plugins/createSyncStoragePersister.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ or
yarn add @tanstack/query-sync-storage-persister @tanstack/react-query-persist-client
```

or

```bash
bun add @tanstack/query-sync-storage-persister @tanstack/react-query-persist-client
```

## Usage

- Import the `createSyncStoragePersister` function
Expand Down
3 changes: 3 additions & 0 deletions docs/framework/solid/devtools.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,11 @@ $ npm i @tanstack/solid-query-devtools
$ pnpm add @tanstack/solid-query-devtools
# or
$ yarn add @tanstack/solid-query-devtools
# or
$ bun add @tanstack/solid-query-devtools
```


You can import the devtools like this:

```tsx
Expand Down
2 changes: 2 additions & 0 deletions docs/framework/svelte/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ $ npm i @tanstack/svelte-query
$ pnpm add @tanstack/svelte-query
# or
$ yarn add @tanstack/svelte-query
# or
$ bun add @tanstack/svelte-query
```

> Wanna give it a spin before you download? Try out the [basic](./examples/basic) example!
2 changes: 2 additions & 0 deletions docs/framework/vue/devtools.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ $ npm i @tanstack/vue-query-devtools
$ pnpm add @tanstack/vue-query-devtools
# or
$ yarn add @tanstack/vue-query-devtools
# or
$ bun add @tanstack/vue-query-devtools
```

By default, Vue Query Devtools are only included in bundles when `process.env.NODE_ENV === 'development'`, so you don't need to worry about excluding them during a production build.
Expand Down
2 changes: 2 additions & 0 deletions docs/framework/vue/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ $ npm i @tanstack/vue-query
$ pnpm add @tanstack/vue-query
# or
$ yarn add @tanstack/vue-query
# or
$ bun add @tanstack/vue-query
```

> Wanna give it a spin before you download? Try out the [basic](./examples/basic) example!
Expand Down
4 changes: 2 additions & 2 deletions examples/angular/basic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

To run this example:

- `npm install` or `yarn` or `pnpm i`
- `npm run start` or `yarn start` or `pnpm start`
- `npm install` or `yarn` or `pnpm i` or `bun i`
- `npm run start` or `yarn start` or `pnpm start` or `bun start`
4 changes: 2 additions & 2 deletions examples/angular/infinite-query-with-max-pages/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

To run this example:

- `npm install` or `yarn` or `pnpm i`
- `npm run start` or `yarn start` or `pnpm start`
- `npm install` or `yarn` or `pnpm i` or `bun i`
- `npm run start` or `yarn start` or `pnpm start` or `bun start`
4 changes: 2 additions & 2 deletions examples/angular/router/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

To run this example:

- `npm install` or `yarn` or `pnpm i`
- `npm run start` or `yarn start` or `pnpm start`
- `npm install` or `yarn` or `pnpm i` or `bun i`
- `npm run start` or `yarn start` or `pnpm start` or `bun start`
4 changes: 2 additions & 2 deletions examples/angular/simple/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

To run this example:

- `npm install` or `yarn` or `pnpm i`
- `npm run start` or `yarn start` or `pnpm start`
- `npm install` or `yarn` or `pnpm i` or `bun i`
- `npm run start` or `yarn start` or `pnpm start` or `bun start`
2 changes: 1 addition & 1 deletion examples/svelte/auto-refetching/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ npm create svelte@latest my-app

## Developing

Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn` or `bun install`), start a development server:

```bash
npm run dev
Expand Down
2 changes: 1 addition & 1 deletion examples/svelte/basic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ npm create svelte@latest my-app

## Developing

Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn` or `bun install`), start a development server:

```bash
npm run dev
Expand Down
2 changes: 1 addition & 1 deletion examples/svelte/load-more-infinite-scroll/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ npm create svelte@latest my-app

## Developing

Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn` or `bun install`), start a development server:

```bash
npm run dev
Expand Down
2 changes: 1 addition & 1 deletion examples/svelte/optimistic-updates-typescript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ npm create svelte@latest my-app

## Developing

Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn` or `bun install`), start a development server:

```bash
npm run dev
Expand Down
2 changes: 1 addition & 1 deletion examples/svelte/ssr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ npm create svelte@latest my-app

## Developing

Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn` or `bun install`), start a development server:

```bash
npm run dev
Expand Down
4 changes: 2 additions & 2 deletions examples/vue/2.6-basic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

To run this example:

- `npm install` or `yarn` or `pnpm i`
- `npm run dev` or `yarn dev` or `pnpm dev`
- `npm install` or `yarn` or `pnpm i` or `bun i`
- `npm run dev` or `yarn dev` or `pnpm dev` or `bun dev`
4 changes: 2 additions & 2 deletions examples/vue/basic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

To run this example:

- `npm install` or `yarn` or `pnpm i`
- `npm run dev` or `yarn dev` or `pnpm dev`
- `npm install` or `yarn` or `pnpm i` or `bun i`
- `npm run dev` or `yarn dev` or `pnpm dev` or `bun dev`
4 changes: 2 additions & 2 deletions examples/vue/simple/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

To run this example:

- `npm install` or `yarn` or `pnpm i`
- `npm run dev` or `yarn dev` or `pnpm dev`
- `npm install` or `yarn` or `pnpm i` or `bun i`
- `npm run dev` or `yarn dev` or `pnpm dev` or `bun dev`
2 changes: 2 additions & 0 deletions packages/angular-query-experimental/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ Visit https://tanstack.com/query/latest/docs/angular/overview
$ pnpm add @tanstack/angular-query-experimental
# or
$ yarn add @tanstack/angular-query-experimental
# or
$ bun add @tanstack/angular-query-experimental
```

2. Initialize **Angular Query** by adding **provideAngularQuery** to your application
Expand Down
2 changes: 2 additions & 0 deletions packages/vue-query/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ Visit https://tanstack.com/query/latest/docs/vue/overview
$ pnpm add @tanstack/vue-query
# or
$ yarn add @tanstack/vue-query
# or
$ bun add @tanstack/vue-query
```

> If you are using Vue 2.6, make sure to also setup [@vue/composition-api](https://github.com/vuejs/composition-api)
Expand Down

0 comments on commit d83aa27

Please sign in to comment.