Skip to content

Commit 83c7763

Browse files
committed
reworked README with icons
1 parent 6fcf2df commit 83c7763

File tree

245 files changed

+77
-3563
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

245 files changed

+77
-3563
lines changed

README.md

Lines changed: 77 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
<h1 align="center">
2-
<br>
32
<img src ="./assets/logos/marqueePromoTitle.png"/>
43
<br>
5-
<br>
64
React Performance Tool
75
<br>
8-
<a href="https://osawards.com/react/">🏆 Nominated for React Open Source Awards 2020 </a>
6+
<a href="https://osawards.com/react/">🏆 Nominated for React Open Source Awards 2020</a>
97
<br>
108
</h1>
119

@@ -31,55 +29,93 @@
3129

3230
### 🔍 State Visualization
3331

34-
You can view your application's file structure and click on a snapshot to view
35-
your app's state. State can be visualized in a Component Graph, JSON Tree,
36-
Performance Graph, or the Accessibility Tree. Snapshot history can be visualized in the History tab.
37-
The Web Metrics tab provides some useful metrics for site performance. The accessibility tab
38-
visualizes an app's accessibility tree per state change.
39-
Snapshots can be compared with the previous snapshot, which can be viewed in Diff mode.
40-
41-
<p>On the main page, there are two main selections from the dropdown panel:</p>
4232
<ul>
4333
<li>
44-
<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. You can also use the play button to replay each state change automatically.
34+
<strong>Multiple Views</strong>: Visualize your application state through Component Graphs, JSON Trees, Performance Graphs, and Accessibility Trees
35+
</li>
36+
<li>
37+
<strong>History Timeline</strong>: Track state changes over time with an intuitive history visualization
38+
</li>
39+
<li>
40+
<strong>Web Metrics</strong>: Monitor critical performance metrics in real-time
41+
</li>
42+
<li>
43+
<strong>Accessibility Insights</strong>: Analyze your app's accessibility tree for each state change
4544
</li>
4645
</ul>
4746
<br>
4847

48+
<p>On the main page, there are two main selections from the dropdown panel:</p>
49+
<ul>
50+
<li>
51+
<strong>Timejump</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. You can also use the play button to replay each state change automatically.
52+
</li>
53+
<li>
54+
<strong>Providers / Consumers</strong>: Understand your application's context dependencies and their interactions better through visualizing its provider and consumer relationships.
55+
</li>
56+
</ul>
57+
<br>
58+
4959
<p align="center">
50-
<img src="./assets/gifs/TimeTravelGif_V26.gif" />
60+
<img src="./assets/gifs/ProviderConsumer_V26.gif" />
5161
</p>
5262
<br>
5363

64+
### ⏱️ Time-Travel Debugging
65+
5466
<ul>
5567
<li>
56-
<strong>Provider/Consumer Tab</strong>: Understand your application's context dependencies and their interactions better through visualizing its provider and consumer relationships.
68+
<strong>State Snapshots</strong>: Capture and navigate through your application's state history
5769
</li>
58-
</ul>
70+
<li>
71+
<strong>Playback Controls</strong>: Automatically replay state changes with adjustable speed
72+
</li>
73+
<li>
74+
<strong>Jump Points</strong>: Instantly navigate to any previous state
75+
</li>
76+
<li>
77+
<strong>Diff Comparisons</strong>: Compare states between snapshots
78+
</li>
79+
</ul>
80+
<br>
5981

6082
<p align="center">
61-
<img src="./assets/gifs/ProviderConsumer_V26.gif" />
83+
<img src="./assets/gifs/TimeTravelGif_V26.gif" />
6284
</p>
63-
64-
<br>
6585
<br>
6686

67-
### 🔹 Recording
87+
### 📊 Performance Analysis
6888

69-
Whenever the state is changed (whenever setState, useState is called), this
70-
extension will create a snapshot of the current state tree and record it. Each
71-
snapshot will be displayed in Chrome DevTools under the Reactime panel.
72-
<br>
73-
<br>
89+
<ul>
90+
<li>
91+
<strong>Component Metrics</strong>: Track render times and performance bottlenecks
92+
</li>
93+
<li>
94+
<strong>Series Comparison</strong>: Compare performance across different sets of state changes
95+
</li>
96+
<li>
97+
<strong>Re-render Detection</strong>: Identify and fix unnecessary render cycles
98+
</li>
99+
<li>
100+
<strong>Web Vitals</strong>: Monitor Core Web Vitals and other performance metrics
101+
</li>
102+
</ul>
103+
<br>
74104

75-
### 🔹 Components Comparison
105+
### 🔄 Modern Framework Support
76106

77-
When toggled to a specific snapshot, a visualization of the individual
78-
components of the snapshot will be displayed. This can be done under the same
79-
Performance tab where the snapshots are rendered. You will also find details of
80-
each component upon hovering.
81-
<br>
82-
<br>
107+
<ul>
108+
<li>
109+
Full compatibility with <strong>Gatsby, Next.js, and Remix</strong>
110+
</li>
111+
<li>
112+
TypeScript support for class and functional components
113+
</li>
114+
<li>
115+
Support for React Hooks and Context API
116+
</li>
117+
</ul>
118+
<br>
83119

84120
### 🔹 Download/Upload Snapshots
85121

@@ -97,45 +133,6 @@ If Reactime loses its connection to the tab you're monitoring, simply click the
97133
<br>
98134
<br>
99135

100-
### 🔹 Re-render Optimization
101-
102-
One of the most common issues that affects performance in React is unnecessary
103-
render cycles. This problem can be fixed by checking your renders in the
104-
Performance tab in Chrome DevTools under the Reactime panel.
105-
<br>
106-
<br>
107-
108-
### 🔹 Jump through your snapshots
109-
110-
Each recorded snapshot comes with its own corresponding vertical slider.
111-
By adjusting the slider a user can jump to any previously recorded snapshots.
112-
Hitting the jump button on any snapshot will allow a user to view state data at
113-
any point in the history of the target application.
114-
<br>
115-
<br>
116-
117-
### 🔹 Play through your snapshots
118-
119-
Users can play through recorded snapshots using the Play/Pause button below the snapshots panel and adjust the playback speed to suit their needs.
120-
<br>
121-
<br>
122-
123-
### 🔹 Gatsby, Next.js, Remix
124-
125-
Reactime offers full support for Gatsby, Next.js, and Remix applications. You would be able to
126-
identify unnecessary renders, duration of each rendering, travel-debugging
127-
features and visual representation of the tree components.
128-
<br>
129-
<br>
130-
131-
### 🔹 TypeScript Support
132-
133-
Reactime offers support for TypeScript applications using stateful class
134-
components and functional components. Further testing and development is
135-
required for custom hooks and Concurrent Mode.
136-
<br>
137-
<br>
138-
139136
### 🔹 Documentation
140137

141138
After cloning this repository, developers can simply run `npm run docs` at the
@@ -162,30 +159,21 @@ If you would like to read more about previous releases, click <a href="https://g
162159

163160
<p align="center">
164161

165-
<h1>Installation</h1>
162+
<h1>🚀 Getting Started</h1>
166163

167164
To get started, install the Reactime
168165
[extension](https://chrome.google.com/webstore/detail/reactime/cgibknllccemdnfhfpmjhffpjfeidjga)
169166
from Chrome Web Store.
170167

171-
After installing Reactime, you can test its functionalities with your React
172-
application in development mode.
168+
After installing Reactime, you can test its functionalities with your React application in development mode.
173169

174-
Please note, the time jumping feature will <b>ONLY</b> work when your
175-
application is running in <b>development mode</b>.
170+
Please note, Reactime will <b>ONLY</b> work when your application is running in <b>development mode</b>.
176171

177172
NOTE: The React Developer Tools
178173
[extension](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en)
179174
is also required for Reactime to run, if you do not already have it installed on
180175
your browser.
181176

182-
### Looking to contribute to Reactime?
183-
184-
<i>Please refer to Developer Install for a detailed guide:</i>
185-
186-
Refer to the [DEVELOPER README](src/DEVELOPER_README.md) for more info on the project, and
187-
instructions on building from source.
188-
189177
### <b>How to Use</b>
190178

191179
After installing the Chrome extension, just open up your project in the browser.
@@ -194,6 +182,13 @@ Then right click on your application and choose the 'Reactime' context menu item
194182

195183
Alternatively, you can open up your Chrome DevTools and navigate to the Reactime panel.
196184

185+
### Looking to contribute to Reactime?
186+
187+
<i>Please refer to Developer Install for a detailed guide:</i>
188+
189+
Refer to the [👩‍💻 Developer README](src/DEVELOPER_README.md) for more info on the project, and
190+
instructions on building from source.
191+
197192
## <b>Troubleshooting</b>
198193

199194
### ❓ <b>Why is Reactime telling me that no React application is found?</b>

docs/.nojekyll

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/assets/highlight.css

Lines changed: 0 additions & 64 deletions
This file was deleted.

docs/assets/main.js

Lines changed: 0 additions & 59 deletions
This file was deleted.

docs/assets/navigation.js

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/assets/search.js

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)