From 3f78b434f18e57750048f7de744b4ae7a6a1c06a Mon Sep 17 00:00:00 2001 From: GwanSik Kim Date: Sat, 29 Jun 2024 05:32:11 +0900 Subject: [PATCH] docs: update `README.md` for root, react-query (#994) # Overview close: #982 I have updated the `README.md` in the root directory and `packages/react-query/README.md`. ## Preview | root `README.md` | | --- | |image| | react-query `README.md` | react-query `README.ko.md` | | --- | --- | | image|image| ## 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 --- .changeset/odd-cougars-admire.md | 5 +++++ README.md | 8 ++++---- packages/react-query/README.ko.md | 11 +++++++++++ packages/react-query/README.md | 13 ++++++++++++- 4 files changed, 32 insertions(+), 5 deletions(-) create mode 100644 .changeset/odd-cougars-admire.md diff --git a/.changeset/odd-cougars-admire.md b/.changeset/odd-cougars-admire.md new file mode 100644 index 000000000..bf0f2c226 --- /dev/null +++ b/.changeset/odd-cougars-admire.md @@ -0,0 +1,5 @@ +--- +"@suspensive/react-query": patch +--- + +docs(react-query): update README.md diff --git a/README.md b/README.md index 97c098239..64d71ba25 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/packages/react-query/README.ko.md b/packages/react-query/README.ko.md index d5f9818d1..1eb9dd145 100644 --- a/packages/react-query/README.ko.md +++ b/packages/react-query/README.ko.md @@ -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 ``` diff --git a/packages/react-query/README.md b/packages/react-query/README.md index cc35632ea..6db075cdb 100644 --- a/packages/react-query/README.md +++ b/packages/react-query/README.md @@ -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