Skip to content

Commit bbdfda2

Browse files
committed
first round of updates to readme
1 parent 48a9265 commit bbdfda2

File tree

1 file changed

+28
-55
lines changed

1 file changed

+28
-55
lines changed

README.md

Lines changed: 28 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -43,64 +43,31 @@
4343
<a href="#how-to-use">How To Use</a> • <a href="#features">Features</a> • <a href="https://www.reacti.me/">Website</a> • <a href="#read-more">Read More</a>
4444
</p>
4545

46-
<b>Reactime 18.0</b> introduces a range of new and improved features aimed at optimizing performance and enhancing compatibility.
47-
With support for Next.js and Remix, increased testing coverage(93% backend, frontend needs more), and structural improvements to the codebase.
48-
Additionally, we are proud to announce the launch of our newly redesigned website, which serves as a hub for the latest updates and information about Reactime.
49-
To aid with debugging, we have included demo applications for Next.js and Remix, enabling future iterators to test and troubleshoot with greater ease and efficiency.
46+
<b>Reactime 19.0</b> comes with UI updates to enhance the developer's experience, as well as a much-needed revamping of the codesbase to reflect current industry standards and better maintainability for future contributors.
47+
48+
<i>UI Updates</i>
49+
50+
To handle displaying large amounts of data, we have changed how nested structures like objects and arrays are displayed to now be collapsible and scrollable. In addition, we've updated component information to include the necessary component "key" information, and data now also persists on hover, eliminating the need to leave the cursor in one place.
51+
52+
<i>Under the Hood</i>
5053

54+
We are happy to say that we've migrated from Enzyme to React Testing Library to eliminate the need for the Enzyme adapter, converted from JavaScript to TypeScript to ensure type safety, and updated the traversal of the React Fiber Tree to accurately extract useState data for previously unsupported edge cases.
55+
56+
<b>Reactime 18.0</b> introduces a range of new and improved features aimed at optimizing performance and enhancing compatibility.
57+
With support for Next.js and Remix, increased testing coverage(93% backend, frontend needs more), and structural improvements to the codebase.
58+
Additionally, we are proud to announce the launch of our newly redesigned website, which serves as a hub for the latest updates and information about Reactime.
59+
To aid with debugging, we have included demo applications for Next.js and Remix, enabling future iterators to test and troubleshoot with greater ease and efficiency.
5160

5261
<b>Reactime 17.0</b>
5362
We are pleased to announce the release of Reactime 17.0,
5463
which includes several new and improved features. Context API support has now been added.
5564
You can now monitor state stored in context if your component is subscribed to context changes.
5665
We also improved the tooltip UI on our tree diagram to improve readability.
5766
In addition, we have redesigned the Reactime.dev website using Tailwind CSS,
58-
resulting in a clean, modern design with an intuitive layout.
59-
To stay informed about future updates, you can now sign up for email notifications.
67+
resulting in a clean, modern design with an intuitive layout.
68+
To stay informed about future updates, you can now sign up for email notifications.
6069

61-
<b>Reactime 16.0</b> presents the codebase with substantial, much-needed
62-
clean-up. From the backend and frontend to testing, the Reactime XVI team has:
63-
removed vestigial code, added comments to clarify code, implemented 100% testing
64-
coverage for the codebase, compartmentalized and modularized files, and
65-
implemented typescript.
66-
67-
The primary purpose of this update is to allow easier understanding of
68-
Reactime's codebase by individuals or groups wishing to further update Reactime,
69-
keeping this great developer tool alive.
70-
71-
With release of Node v18.12.1(LTS) on 11/4/22, the script has been updated to
72-
'npm run dev' || 'npm run build' for backwards compatibility.<br/> For version
73-
Node v16.16.0, please use script 'npm run devlegacy' || 'npm run buildlegacy'
74-
75-
Previously, <b>Reactime 14.0 and 15.0</b> added the exciting features below:
76-
77-
I. React Router Compatibility <br> Reactime is now compatible with React Router
78-
applications! Prior to Reactime 14.0, recording state snapshots as the user
79-
navigated across various routes was possible, but time travel debugging was only
80-
possible for the current route (i.e. jumping back to a prior state at a
81-
different route was not possible). In order to streamline debugging of
82-
applications with multiple routes, Reactime 14.0 added functionality that allows
83-
the user to time-travel back to different routes, including live updating in the
84-
browser to reflect the state of their application at that previously visited
85-
route.
86-
87-
II. Classifying State Snapshots by Route <br> The list of state snapshots in the
88-
Reactime dashboard is now classified by route to give the developer visual cues
89-
of the snapshot-route relationship and make time travel debugging of various
90-
routes easier.
91-
92-
III. Filtering Performance Metrics By Route <br> The Reactime dashboard includes
93-
a stacked bar graph showing render times for each component, with a separate bar
94-
stack for each snapshot. With Reactime 14.0, this composite bar graph can now be
95-
filtered by route to allow the developer to review detailed performance data by
96-
route.
97-
98-
IV. Visualize And Compare Components Within a Snapshot <br> Users not only have
99-
access to multiple snapshots, but can now zone into a specified snapshot more
100-
granularly through a new visualization consisting of its individual components.
101-
These new graphs are rendered directly in the same Performance tab in Reactime
102-
and provide details for each component when the user hovers over, providing a
103-
new visual comparison of components across a single chosen state.
70+
If you would like to read more about previous releases, click <a href="https://github.com/open-source-labs/reactime/releases">here!</a>
10471

10572
<p align="center">
10673
<img src="./assets/snapshot-comparison.gif" />
@@ -152,6 +119,10 @@ Reactime initially runs using the dev tools global hook from the Chrome API. It
152119
takes time for Chrome to load this. Try refreshing your application a couple
153120
times until you see Reactime running.
154121

122+
### ❓ <b>Why do I need to have React Dev Tools enabled?</b>
123+
124+
Reactime works in tandem with the React Developer Tools to access a React application's Fiber tree; under the hood, Reactime traverses the Fiber tree through the React Developer Tool's global hook, pulling all relevant information needed to display to the developer
125+
155126
### ❓ <b>There is a black screen instead of the Reactime extension</b>
156127

157128
Try refreshing the application you want to test and refresh the DevTools by
@@ -176,7 +147,7 @@ Node v16.16.0, please use script 'npm run devlegacy' | 'npm run buildlegacy'
176147

177148
You can view your application's file structure and click on a snapshot to view
178149
your app's state. State can be visualized in a Component Graph, JSON Tree, or
179-
Performance Graph. Snapshots can be diffed with the previous snapshot, which can
150+
Performance Graph. Snapshots can be compared with the previous snapshot, which can
180151
be viewed in Diff mode.
181152
<br>
182153
<br>
@@ -256,7 +227,6 @@ application faster.
256227
Reactime offers debugging and performance tools for Remix apps (in beta). Support still
257228
needs to be added for multi-route time traveling. Every other feature works.
258229

259-
260230
### 🔹 TypeScript Support
261231

262232
Reactime offers support for TypeScript applications using stateful class
@@ -281,23 +251,22 @@ of the structure and interfaces of the codebase.
281251
- A dropdown to support development of projects on multiple tabs
282252
- A slider to move through snapshots quickly
283253
- A play button to move through snapshots automatically
284-
- A lock button, which stops recording each snapshot
285-
- A persist button to keep snapshots upon refresh (handy when changing code and
286-
debugging)
287254
- Download/upload the current snapshots in memory
288255
- Declarative titles in the actions sidebar
289256
- Interative Tutorial Walkthrough
290257
- Toggle feature allowing temporary pause of state monitoring
291258

292-
293259
### <b>Bug Fixes</b>
260+
294261
- Search bar now searches for specific nodes successfully
295262
- Tab titles of chrome browser tabs not running an application in development
296263
mode are no longer affected by Reactime
297264
- Overhauled Asynchronous calls to eliminate memory leaks due to unused async activities in the background.
298265
- Improved UI and performance
299266

300267
## <b>Read More</b>
268+
269+
- [NAME OF 19'S MEDIUM ARTICLE](linkhere)
301270
- [Reactime 18.0. Better than ever](https://medium.com/@zdf2424/reactime-18-0-better-than-ever-148b81606257)
302271
- [Reactime v17.0.0: Now with support for the Context API, and a modern UI](https://medium.com/@reactime/reactime-v17-0-0-now-with-support-for-the-context-api-and-a-modern-ui-f0edf9e54dae)
303272
- [Reactime XVI: Clean-up Time](https://medium.com/@emintahirov1996/reactime-xvi-cleanup-time-a14ba3dcc8a6)
@@ -390,6 +359,10 @@ of the structure and interfaces of the codebase.
390359
- **Ngoc Zwolinski** - [@ngoczwolinski](https://github.com/ngoczwolinski)
391360
- **Peter Lam** - [@dev-plam](https://github.com/dev-plam)
392361
- **Zachary Freeman** - [@zacharydfreeman](https://github.com/zacharydfreeman/)
362+
- **Jackie Yuan** - [@yuanjackie1](https://github.com/yuanjackie1)
363+
- **Jasmine Noor** - [@jasnoo](https://github.com/jasnoo)
364+
- **Minzo Kim** - [@minzo-kim](https://github.com/minzo-kim)
365+
- **Mark Teets** - [@MarkTeets](https://github.com/MarkTeets)
393366

394367
## <b>License </b>
395368

0 commit comments

Comments
 (0)