toss / suspensive

Packages to use React Suspense easily (one of Tanstack Query community resources)
https://suspensive.org
MIT License
417 stars 37 forks source link

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

Closed gwansikk closed 1 week ago

gwansikk commented 1 week ago

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

  1. I read the Contributing Guide
  2. I added documents and tests.
vercel[bot] commented 1 week ago

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[bot] commented 1 week ago

🦋 Changeset detected

Latest commit: 184a77d610621db44236f04841772e4031dd26c6

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[bot] commented 1 week ago

CodSpeed Performance Report

Merging #994 will create unknown performance changes

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

Summary

:warning: No benchmarks were detected in both the base of the PR and the PR.

codecov-commenter commented 1 week ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

:exclamation: 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 [![Impacted file tree graph](https://app.codecov.io/gh/toss/suspensive/pull/994/graphs/tree.svg?width=650&height=150&src=pr&token=5PopssACmx&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss)](https://app.codecov.io/gh/toss/suspensive/pull/994?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) ```diff @@ 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](https://app.codecov.io/gh/toss/suspensive/pull/994/components?src=pr&el=components&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | Coverage Δ | | |---|---|---| | [@suspensive/react](https://app.codecov.io/gh/toss/suspensive/pull/994/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | `97.03% <ø> (ø)` | | | [@suspensive/react-query](https://app.codecov.io/gh/toss/suspensive/pull/994/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | `∅ <ø> (∅)` | | | [@suspensive/react-query-4](https://app.codecov.io/gh/toss/suspensive/pull/994/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | `0.00% <ø> (ø)` | | | [@suspensive/react-query-5](https://app.codecov.io/gh/toss/suspensive/pull/994/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | `0.00% <ø> (ø)` | | | [@suspensive/react-await](https://app.codecov.io/gh/toss/suspensive/pull/994/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | `100.00% <ø> (ø)` | | | [@suspensive/react-image](https://app.codecov.io/gh/toss/suspensive/pull/994/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | `80.39% <ø> (ø)` | |