Skip to content

Commit 538e597

Browse files
authored
docs: add usage
1 parent af0940c commit 538e597

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,25 @@
22

33
[![Build Status](https://app.travis-ci.com/bamlab/react-native-performance.svg?branch=master)](https://app.travis-ci.com/bamlab/react-native-performance)
44

5-
Only Android is supported for now.
5+
Only Android is supported for now. Add a 👍 on [this issue](https://github.com/bamlab/react-native-performance/issues/18) if you want to see iOS support.
66

77
![rn-perf-monitor](https://user-images.githubusercontent.com/4534323/151138734-dc9af3b1-1e96-4416-8abd-346597a4dbe8.gif)
88

99

10+
## Usage
11+
12+
1. Disable *JS Dev Mode* in the settings (shake your device to open the development menu, then click settings)
13+
2. Click **Start Measuring**
14+
3. Do stuff in your app
15+
4. Check the score!
16+
1017
This is how the score is calculated below, quite naively, but open to suggestions:
1118
<img width="1050" alt="plugin-score" src="https://user-images.githubusercontent.com/4534323/142174520-ab09e61c-9727-4969-8e1e-a9b688f9fd78.png">
1219

20+
Note that:
21+
- the score depends on the device used. We advice using a lower-end device to accentuate performance issues.
22+
- the score depends on what you do on your app while measuring. If you do nothing, your score should (hopefully) be 100!
23+
1324
## Install
1425

1526
### Flipper

0 commit comments

Comments
 (0)