Skip to content

Commit 41d022b

Browse files
committed
docs: Update README.md with improved description
1 parent a9bbb93 commit 41d022b

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
1-
# <img src="https://react-scan.million.dev/logo.svg" /> React Scan
1+
# <img src="https://github.com/aidenybai/react-scan/blob/main/.github/assets/logo.svg" width="30" height="30" /> React Scan
22

33
React Scan detects performance issues in your React app.
44

55
Previously, tools like [<Profiler />](https://react.dev/reference/react-devtools), [Why Did You Render?](https://github.com/welldone-software/why-did-you-render), and [React Devtools](https://legacy.reactjs.org/blog/2018/09/10/introducing-the-react-profiler.html) required lots of manual code change, lacked simple visual cues, and had a high noise-to-signal ratio.
66

7-
React Scan fixes this by automatically detecting and highlighting the components that are causing performance issues. This filters out the noise and focuses on the signal.
7+
Instead, React Scan automatically detects and highlights components that cause performance issues. This filters out the noise and shows you exactly what you need to fix.
88

99
It's also just JavaScript, so you drop it in anywhere – script tag, npm, you name it!
1010

1111
[**Try it out! →**](https://react-scan.million.dev)
1212

13+
![React Scan in action](https://raw.githubusercontent.com/aidenybai/react-scan/refs/heads/main/.github/assets/demo.gif?token=GHSAT0AAAAAAB4IOFACRC6P6E45TB2FPYFCZZV2AYA)
14+
1315
## Install
1416

1517
The simplest way to use it is to add this script to your app:

0 commit comments

Comments
 (0)