Skip to content

Commit

Permalink
docs: update README.md for root, react-query (#994)
Browse files Browse the repository at this point in the history
# Overview

close: #982

I have updated the `README.md` in the root directory and
`packages/react-query/README.md`.

## Preview

| root `README.md` |
| --- |
|<img width="1009" alt="image"
src="https://github.com/toss/suspensive/assets/39869096/1b44a485-4c5b-4ef9-a4c7-829b6d2c3c5f">|

| react-query `README.md` | react-query `README.ko.md` |
| --- | --- |
| <img width="1025" alt="image"
src="https://github.com/toss/suspensive/assets/39869096/5c71ddd8-87c4-4648-bfad-dc442b9a6bbc">|<img
width="1030" alt="image"
src="https://github.com/toss/suspensive/assets/39869096/63a3694e-319d-4096-b5e8-6b8285aadf91">|

## PR Checklist

- [x] I did below actions if need

1. I read the [Contributing
Guide](https://github.com/toss/suspensive/blob/main/CONTRIBUTING.md)
2. I added documents and tests.

---------

Co-authored-by: Jonghyeon Ko <jonghyeon@toss.im>
  • Loading branch information
gwansikk and manudeli authored Jun 28, 2024
1 parent cc73afa commit 3f78b43
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 5 deletions.
5 changes: 5 additions & 0 deletions .changeset/odd-cougars-admire.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@suspensive/react-query": patch
---

docs(react-query): update README.md
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,22 +91,22 @@ Declarative apis to use [@tanstack/react-query with suspense](https://tanstack.c
### Features

- useSuspenseQuery, useSuspenseQueries, useSuspenseInfiniteQuery
- SuspenseQuery, SuspenseInfiniteQuery
- SuspenseQuery, SuspenseQueries, SuspenseInfiniteQuery
- QueryErrorBoundary
- queryOptions

### Installation

```shell
npm install @suspensive/react-query @tanstack/react-query@4
npm install @suspensive/react-query @tanstack/react-query
```

```shell
pnpm add @suspensive/react-query @tanstack/react-query@4
pnpm add @suspensive/react-query @tanstack/react-query
```

```shell
yarn add @suspensive/react-query @tanstack/react-query@4
yarn add @suspensive/react-query @tanstack/react-query
```

### Usage
Expand Down
11 changes: 11 additions & 0 deletions packages/react-query/README.ko.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,19 @@

## 설치하기

@suspensive/react-query는 npm에 있습니다.

2.2.0 버전 이후로는 @tanstack/react-query의 v4와 v5을 모두 지원합니다. package.json의 dependencies에 @tanstack/react-query의 버전에 따라 자동으로 알맞는 @suspensive/react-query 버전을 사용하게 됩니다.

@suspensive/react-query 는 npm에 있습니다. 최신 안정버전을 설치하기 위해 아래 커맨드를 실행하세요

```shell npm2yarn
npm install @suspensive/react-query @tanstack/react-query
```

@tanstack/react-query v4는 @tanstack/react-query v5 보다 [더 낮은 버전의 브라우저](https://suspensive.org/ko/docs/react-query/motivation#tanstackreact-query-v5%EC%9D%98-es-private-field%EB%A1%9C-%EC%9D%B8%ED%95%B4-%EC%A0%80%EB%B2%84%EC%A0%84%EC%9D%98-%EB%B8%8C%EB%9D%BC%EC%9A%B0%EC%A0%80%EB%A5%BC-%EC%A7%80%EC%9B%90%ED%95%98%EC%A7%80-%EB%AA%BB%ED%95%98%EB%8A%94-%EB%AC%B8%EC%A0%9C%EB%A5%BC-%ED%95%B4%EA%B2%B0%ED%95%A9%EB%8B%88%EB%8B%A4)를 지원합니다.
@tanstack/react-query v4를 사용하고자 하면 아래 커맨드를 실행하세요.

```shell npm2yarn
npm install @suspensive/react-query @tanstack/react-query@4
```
13 changes: 12 additions & 1 deletion packages/react-query/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,18 @@

## Installation

@suspensive/react-query lives in npm. To install the latest stable version, run the following command
@suspensive/react-query is available on npm.

From version 2.2.0 onwards, it supports both v4 and v5 of @tanstack/react-query. Depending on the version of @tanstack/react-query specified in your package.json dependencies, the appropriate version of @suspensive/react-query will be used automatically.

To use the latest stable version, run the following command.

```shell npm2yarn
npm install @suspensive/react-query @tanstack/react-query
```

To use @tanstack/react-query v4, run the following command.
@tanstack/react-query v4 supports [lower version browsers](https://suspensive.org/docs/react-query/motivation#solution-for-the-issue-of-tanstackreact-query-v5-not-being-able-to-support-lower-version-browsers-due-to-es-private-field) compared to v5.

```shell npm2yarn
npm install @suspensive/react-query @tanstack/react-query@4
Expand Down

0 comments on commit 3f78b43

Please sign in to comment.