Skip to content

Commit 20c8eee

Browse files
authored
Merge pull request #36 from oslabs-beta/PatriceFeature
update icons and readme
2 parents 41024f0 + f90943e commit 20c8eee

13 files changed

+27
-5
lines changed

README.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,22 @@
3939
### 🔹 Viewing
4040

4141
You can view your application's file structure and click on a snapshot to view
42-
your app's state. State can be visualized in a Component Graph, JSON Tree, or
43-
Performance Graph. Snapshot history can be visualized in the History tab.
42+
your app's state. State can be visualized in a Component Graph, JSON Tree,
43+
Performance Graph, or the Accessibility Tree. Snapshot history can be visualized in the History tab.
4444
The Web Metrics tab provides some useful metrics for site performance. The accessibility tab
4545
visualizes an app's accessibility tree per state change.
4646
Snapshots can be compared with the previous snapshot, which can be viewed in Diff mode.
47+
48+
<p>On the main page, there are two main selections from the dropdown panel:</p>
49+
<ul>
50+
<li>
51+
<strong>Timejump Tab</strong>: View and navigate through the snapshot history of your application's state. You can jump to any point in time to see how the state evolves across changes.
52+
</li>
53+
<li>
54+
<strong>Provider/Consumer Tab</strong>: Understand your application's context dependencies and their interactions better through visualizing its provider and consumer relationships.
55+
</li>
56+
</ul>
57+
4758
<br>
4859
<br>
4960

@@ -103,14 +114,21 @@ Performance tab in Chrome DevTools under the Reactime panel.
103114
<br>
104115
<br>
105116

106-
### 🔹 Jumping
117+
### 🔹 Jump through your snapshots
107118

108-
Using the actions sidebar, a user can jump to any previously recorded snapshots.
119+
Each recorded snapshot comes with its own corresponding vertical slider.
120+
By adjusting the slider a user can jump to any previously recorded snapshots.
109121
Hitting the jump button on any snapshot will allow a user to view state data at
110122
any point in the history of the target application.
111123
<br>
112124
<br>
113125

126+
### 🔹 Play through your snapshots
127+
128+
Users can play through recorded snapshots using the Play/Pause button below the snapshots panel and adjust the playback speed to suit their needs.
129+
<br>
130+
<br>
131+
114132
### 🔹 Gatsby
115133

116134
Reactime offers full support for Gatsby applications. You would be able to
@@ -250,7 +268,11 @@ Node v16.16.0, please use script 'npm run devlegacy' | 'npm run buildlegacy'
250268
- [Relaunching Reactime: Updates and a New Accessibility Feature!](https://medium.com/@evaury/relaunching-reactime-updates-and-a-new-accessibility-feature-1f0fd3a5bd8c)
251269

252270
## <b>Authors</b>
253-
271+
- **Garrett Chow** - [@garrettlchow](https://github.com/garrettlchow)
272+
- **Ellie Simens** - [@elliesimens](https://github.com/elliesimens)
273+
- **Ragad Mohammed** - [@ragad-mohammed](https://github.com/ragad-mohammed)
274+
- **Daniel Ryczek** - [@dryczek14](https://github.com/dryczek01)
275+
- **Patrice Pinardo** - [@pinardo88](https://github.com/pinardo88)
254276
- **Haider Ali** - [@hali03](https://github.com/hali03)
255277
- **Jose Luis Sanchez** - [@JoseSanchez1996](https://github.com/JoseSanchez1996)
256278
- **Logan Nelsen** - [@ljn16](https://github.com/ljn16)
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)