From 431cd0626daf6ef54051f87c5862bf18ec141edf Mon Sep 17 00:00:00 2001 From: wehub-resource-sync Date: Mon, 13 Jul 2026 10:09:26 +0000 Subject: [PATCH] docs: preserve upstream English README --- README.en.md | 240 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 240 insertions(+) create mode 100644 README.en.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..cced77e --- /dev/null +++ b/README.en.md @@ -0,0 +1,240 @@ +# React Scan + +React Scan automatically detects performance issues in your React app. + +- Requires no code changes -- just drop it in +- Highlights exactly the components you need to optimize +- Always accessible through a toolbar on page + +### Quick Start + +```bash +npx -y react-scan@latest init +``` + +### [**Try out a demo! →**](https://react-scan.million.dev) +React Scan in action + +## Install + +The `init` command will automatically detect your framework, install `react-scan` via npm, and set up your project. + +```bash +npx -y react-scan@latest init +``` + +### Manual Installation + +Install the package: + +```bash +npm install -D react-scan +``` + +Then add the script tag to your app. Pick the guide for your framework: + +#### Script Tag + +Paste this before any scripts in your `index.html`: + +```html + + +``` + +#### Next.js (App Router) + +Add this inside of your `app/layout.tsx`: + +```tsx +import Script from "next/script"; + +export default function RootLayout({ children }) { + return ( + + + + + +
+ + + +``` + +#### Remix + +Add this inside your `app/root.tsx`: + +```tsx +import { Links, Meta, Outlet, Scripts } from "@remix-run/react"; + +export default function App() { + return ( + + + +