Skip to content

Commit 9cb38d1

Browse files
committed
docs(README): Update installation instruction and roadmap
1 parent 8dc8f17 commit 9cb38d1

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Get started in 5 seconds, add this script to your app:
2323
<script src="https://unpkg.com/react-scan/dist/auto.global.js"></script>
2424
```
2525

26-
Or, install it via npm:
26+
**_Or_**, install it via npm:
2727

2828
```bash
2929
npm install react-scan
@@ -76,13 +76,17 @@ We expect all contributors to abide by the terms of our [Code of Conduct](https:
7676

7777
[**→ Start contributing on GitHub**](https://github.com/aidenybai/react-scan/blob/main/.github/CONTRIBUTING.md)
7878

79+
## Roadmap
80+
7981
- [x] Scan only for unnecessary renders ("unstable" props)
8082
- [x] Scan API (`withScan`, `scan`)
8183
- [ ] Offscreen canvas on worker thread
8284
- [ ] React Native support
8385
- [ ] Chrome extension
8486
- [ ] Cleanup config options
8587
- [ ] Name / explain the actual problem
88+
- [ ] More sound options API (start log at certain area, stop log, etc.)
89+
- [ ] Expose primitives / internals for advanced use cases
8690
- [ ] Add more problem detections other than props
8791
- [ ] Simple FPS counter
8892
- [ ] Drag and select areas of the screen to scan

0 commit comments

Comments
 (0)