Skip to content

Commit 4bbeb8a

Browse files
committed
docs: update README for clarity and remove JSON report mention
1 parent a3d4219 commit 4bbeb8a

1 file changed

Lines changed: 3 additions & 20 deletions

File tree

README.md

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
- Visual emoji markers next to React components (customizable)
1010
- Hover tooltips with optimization details and error messages
1111
- Preview compiled output to see what the React Compiler generates
12-
- Generate JSON reports for a full-project compilation snapshot
12+
- Generate reports for a full-project compilation snapshot
1313
- Commands to activate/deactivate markers or check individual files
1414
- Configurable babel plugin path for custom setups
1515

@@ -50,7 +50,7 @@ Each client has its own version and release cycle. See individual READMEs for cl
5050
1. Install from [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=blazejkustra.react-compiler-marker) or search "React Compiler Marker" in Extensions
5151
3. Open a React component file - markers appear automatically
5252

53-
### WebStorm / IntelliJ IDEA (beta)
53+
### WebStorm / IntelliJ IDEA
5454

5555
1. Build the plugin: `cd packages/intellij-client && ./gradlew buildPlugin`
5656
2. Install from disk: Settings > Plugins > Install Plugin from Disk
@@ -81,29 +81,12 @@ See the [Neovim Client README](packages/nvim-client/README.md) for configuration
8181
8282
See the [Zed Client README](packages/zed-client/README.md) for installation and configuration options.
8383

84-
## Configuration
85-
86-
All clients support these settings:
87-
88-
| Setting | Default | Description |
89-
|---------|---------|-------------|
90-
| Success Emoji | `` | Marker for optimized components |
91-
| Error Emoji | `🚫` | Marker for failed components |
92-
| Babel Plugin Path | `node_modules/babel-plugin-react-compiler` | Path to the compiler plugin |
93-
94-
## Commands
95-
96-
- **Activate Extension** - Enable markers
97-
- **Deactivate Extension** - Disable markers
98-
- **Check Current File** - Refresh markers in the active file
99-
- **Preview Compiled Output** - View the compiled code
100-
- **Generate Report** - Save a JSON report for the current workspace
101-
10284
## Links
10385

10486
- [GitHub Repository](https://github.com/blazejkustra/react-compiler-marker)
10587
- [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=blazejkustra.react-compiler-marker)
10688
- [Open VSX Registry](https://open-vsx.org/extension/blazejkustra/react-compiler-marker)
89+
- [Jetbrains Marketplace](https://plugins.jetbrains.com/plugin/29540-react-compiler-marker)
10790
- [React Compiler Documentation](https://react.dev/learn/react-compiler)
10891

10992
## Contributing

0 commit comments

Comments
 (0)