docs: update `README.md` for root, react-query #994

gwansikk · 2024-06-27T17:03:09Z

Overview

close: #982

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

Preview

root `README.md`

react-query `README.md`	react-query `README.ko.md`

PR Checklist

I did below actions if need

I read the Contributing Guide
I added documents and tests.

vercel · 2024-06-27T17:03:13Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
suspensive.org	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 28, 2024 8:29pm
v1.suspensive.org	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 28, 2024 8:29pm
visualization.suspensive.org	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 28, 2024 8:29pm

changeset-bot · 2024-06-27T17:03:13Z

🦋 Changeset detected

Latest commit: 184a77d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages

Name	Type
@suspensive/react-query	Patch
@suspensive/react	Patch
@suspensive/react-query-4	Patch
@suspensive/react-query-5	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

codspeed-hq · 2024-06-27T17:04:48Z

CodSpeed Performance Report

Merging #994 will create unknown performance changes

_{Comparing docs/feat/readme (184a77d) with main (0991644)}

Summary

⚠️ No benchmarks were detected in both the base of the PR and the PR.

manudeli · 2024-06-27T17:51:48Z

packages/react-query/README.md

@@ -11,5 +11,5 @@
 @suspensive/react-query lives in npm. To install the latest stable version, run the following command

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


Add use case for @tanstack/react-query@4 please

codecov-commenter · 2024-06-27T18:34:31Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.33%. Comparing base (0991644) to head (d88c432).

❗ Current head d88c432 differs from pull request most recent head 184a77d

Please upload reports for the commit 184a77d to get more accurate results.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #994   +/-   ##
=======================================
  Coverage   87.33%   87.33%           
=======================================
  Files          38       38           
  Lines         450      450           
  Branches       99       98    -1     
=======================================
  Hits          393      393           
  Misses         54       54           
  Partials        3        3

Components	Coverage Δ
@suspensive/react	`97.03% <ø> (ø)`
@suspensive/react-query	`∅ <ø> (∅)`
@suspensive/react-query-4	`0.00% <ø> (ø)`
@suspensive/react-query-5	`0.00% <ø> (ø)`
@suspensive/react-await	`100.00% <ø> (ø)`
@suspensive/react-image	`80.39% <ø> (ø)`

manudeli

This improvement should be contained in new version of @suspensive/react-query 🚀🚀🚀🚀🚀

@gwansikk

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @suspensive/react-query@2.3.1 ### Patch Changes - [#994](#994) [`647fa47`](647fa47) Thanks [@gwansikk](https://github.com/gwansikk)! - docs(react-query): update README.md - Updated dependencies \[]: - @suspensive/react@2.3.1 - @suspensive/react-query-4@2.3.1 - @suspensive/react-query-5@2.3.1 ## @suspensive/react-query-4@2.3.1 ### Patch Changes - Updated dependencies \[]: - @suspensive/react@2.3.1 ## @suspensive/react-query-5@2.3.1 ### Patch Changes - Updated dependencies \[]: - @suspensive/react@2.3.1 ## @suspensive/react@2.3.1 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

# 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>

@gwansikk

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @suspensive/react-query@2.3.1 ### Patch Changes - [#994](#994) [`647fa47`](647fa47) Thanks [@gwansikk](https://github.com/gwansikk)! - docs(react-query): update README.md - Updated dependencies \[]: - @suspensive/react@2.3.1 - @suspensive/react-query-4@2.3.1 - @suspensive/react-query-5@2.3.1 ## @suspensive/react-query-4@2.3.1 ### Patch Changes - Updated dependencies \[]: - @suspensive/react@2.3.1 ## @suspensive/react-query-5@2.3.1 ### Patch Changes - Updated dependencies \[]: - @suspensive/react@2.3.1 ## @suspensive/react@2.3.1 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

# 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. ---------

@gwansikk

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @suspensive/react-query@2.3.1 ### Patch Changes - [#994](#994) [`647fa47`](647fa47) Thanks [@gwansikk](https://github.com/gwansikk)! - docs(react-query): update README.md - Updated dependencies \[]: - @suspensive/react@2.3.1 - @suspensive/react-query-4@2.3.1 - @suspensive/react-query-5@2.3.1 ## @suspensive/react-query-4@2.3.1 ### Patch Changes - Updated dependencies \[]: - @suspensive/react@2.3.1 ## @suspensive/react-query-5@2.3.1 ### Patch Changes - Updated dependencies \[]: - @suspensive/react@2.3.1 ## @suspensive/react@2.3.1

# 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>

@gwansikk

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @suspensive/react-query@2.3.1 ### Patch Changes - [#994](#994) [`647fa47`](647fa47) Thanks [@gwansikk](https://github.com/gwansikk)! - docs(react-query): update README.md - Updated dependencies \[]: - @suspensive/react@2.3.1 - @suspensive/react-query-4@2.3.1 - @suspensive/react-query-5@2.3.1 ## @suspensive/react-query-4@2.3.1 ### Patch Changes - Updated dependencies \[]: - @suspensive/react@2.3.1 ## @suspensive/react-query-5@2.3.1 ### Patch Changes - Updated dependencies \[]: - @suspensive/react@2.3.1 ## @suspensive/react@2.3.1

# 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>

@gwansikk

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @suspensive/react-query@2.3.1 ### Patch Changes - [#994](#994) [`647fa47`](647fa47) Thanks [@gwansikk](https://github.com/gwansikk)! - docs(react-query): update README.md - Updated dependencies \[]: - @suspensive/react@2.3.1 - @suspensive/react-query-4@2.3.1 - @suspensive/react-query-5@2.3.1 ## @suspensive/react-query-4@2.3.1 ### Patch Changes - Updated dependencies \[]: - @suspensive/react@2.3.1 ## @suspensive/react-query-5@2.3.1 ### Patch Changes - Updated dependencies \[]: - @suspensive/react@2.3.1 ## @suspensive/react@2.3.1

docs: update README.md

153b06c

gwansikk self-assigned this Jun 27, 2024

gwansikk requested review from manudeli, okinawaa and minsoo-web as code owners June 27, 2024 17:03

github-actions bot added the @suspensive/react-query label Jun 27, 2024

manudeli reviewed Jun 27, 2024

View reviewed changes

Merge branch 'main' into docs/feat/readme

66742f0

vercel bot deployed to Preview – suspensive.org June 27, 2024 18:32 View deployment

vercel bot deployed to Preview – v1.suspensive.org June 27, 2024 18:32 View deployment

vercel bot deployed to Preview – visualization.suspensive.org June 27, 2024 18:34 View deployment

Merge branch 'main' into docs/feat/readme

0b39002

vercel bot deployed to Preview – v1.suspensive.org June 27, 2024 18:45 View deployment

vercel bot deployed to Preview – visualization.suspensive.org June 27, 2024 18:46 View deployment

vercel bot deployed to Preview – suspensive.org June 27, 2024 18:47 View deployment

Merge branch 'main' into docs/feat/readme

c9a8bec

vercel bot deployed to Preview – suspensive.org June 28, 2024 05:12 View deployment

vercel bot deployed to Preview – visualization.suspensive.org June 28, 2024 05:13 View deployment

vercel bot deployed to Preview – v1.suspensive.org June 28, 2024 05:13 View deployment

Merge branch 'main' into docs/feat/readme

6ace712

vercel bot deployed to Preview – suspensive.org June 28, 2024 08:40 View deployment

vercel bot deployed to Preview – visualization.suspensive.org June 28, 2024 08:41 View deployment

vercel bot deployed to Preview – v1.suspensive.org June 28, 2024 08:42 View deployment

gwansikk marked this pull request as draft June 28, 2024 09:25

docs(react-query): update readme

e069c25

vercel bot deployed to Preview – v1.suspensive.org June 28, 2024 13:42 View deployment

vercel bot deployed to Preview – visualization.suspensive.org June 28, 2024 13:43 View deployment

vercel bot deployed to Preview – suspensive.org June 28, 2024 13:44 View deployment

gwansikk changed the title ~~docs: update README.md~~ docs: update README.md for root, react-query Jun 28, 2024

gwansikk marked this pull request as ready for review June 28, 2024 14:00

gwansikk requested a review from manudeli June 28, 2024 14:00

manudeli added 2 commits June 29, 2024 05:27

Merge branch 'main' into docs/feat/readme

d88c432

Create odd-cougars-admire.md

184a77d

vercel bot deployed to Preview – visualization.suspensive.org June 28, 2024 20:29 View deployment

vercel bot deployed to Preview – suspensive.org June 28, 2024 20:29 View deployment

vercel bot deployed to Preview – v1.suspensive.org June 28, 2024 20:29 View deployment

manudeli approved these changes Jun 28, 2024

View reviewed changes

manudeli merged commit 647fa47 into main Jun 28, 2024
16 checks passed

manudeli deleted the docs/feat/readme branch June 28, 2024 20:32

github-actions bot mentioned this pull request Jun 28, 2024

chore: version packages #1004

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: update `README.md` for root, react-query #994

docs: update `README.md` for root, react-query #994

gwansikk commented Jun 27, 2024 •

edited by manudeli

Loading

vercel bot commented Jun 27, 2024 •

edited

Loading

changeset-bot bot commented Jun 27, 2024 •

edited

Loading

codspeed-hq bot commented Jun 27, 2024 •

edited

Loading

manudeli Jun 27, 2024

codecov-commenter commented Jun 27, 2024 •

edited

Loading

manudeli left a comment

docs: update README.md for root, react-query #994

docs: update README.md for root, react-query #994

Conversation

gwansikk commented Jun 27, 2024 • edited by manudeli Loading

Overview

Preview

PR Checklist

vercel bot commented Jun 27, 2024 • edited Loading

changeset-bot bot commented Jun 27, 2024 • edited Loading

🦋 Changeset detected

codspeed-hq bot commented Jun 27, 2024 • edited Loading

CodSpeed Performance Report

Merging #994 will create unknown performance changes

Summary

manudeli Jun 27, 2024

Choose a reason for hiding this comment

codecov-commenter commented Jun 27, 2024 • edited Loading

Codecov Report

manudeli left a comment

Choose a reason for hiding this comment

docs: update `README.md` for root, react-query #994

docs: update `README.md` for root, react-query #994

gwansikk commented Jun 27, 2024 •

edited by manudeli

Loading

vercel bot commented Jun 27, 2024 •

edited

Loading

changeset-bot bot commented Jun 27, 2024 •

edited

Loading

codspeed-hq bot commented Jun 27, 2024 •

edited

Loading

codecov-commenter commented Jun 27, 2024 •

edited

Loading