Skip to content

Commit ab5b26b

Browse files
committed
new features added to readme
1 parent 385a859 commit ab5b26b

File tree

3 files changed

+15
-4
lines changed

3 files changed

+15
-4
lines changed

README.fr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030

3131
<h5 align="center">
3232
<br>
33-
<a href="./README.rus.md">🇷🇺 &nbsp; РУССКАЯ ВЕРСИЯ</a> &nbsp;&nbsp; <a href="./README.fr.md">🇫🇷 &nbsp; VERSION FRANÇAISE</a>
33+
<a href="./README.rus.md">🇷🇺 &nbsp; РУССКАЯ ВЕРСИЯ</a> &nbsp;&nbsp; <a href="./README.md">🇷🇺 &nbsp; ENGLISH VERSION </a>
3434
<br>
3535
</h5>
3636
<br>

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<br>
1010
</h1>
1111

12-
<h4 align="center"> Reactime is a performance and debugging tool for React developers. It records a snapshot whenever a target application's state is changed and allows the user to jump to any previously recorded state. </h4>
12+
<h4 align="center"> Reactime is a performance and debugging tool for React developers <b>(compatible with Gatsy and Next.js)</b>. It records a snapshot whenever a target application's state is changed and allows the user to jump to any previously recorded state, detect the amount of renders of each component and average time of rendering.</h4>
1313

1414
<br>
1515
<p align="center">
@@ -43,14 +43,14 @@
4343
  <a href="#how-to-use">How To Use</a> • <a href="#features">Features</a> • <a href="https://reactime.io">Website</a> • <a href="#read-more">Read More</a>
4444
</p>
4545

46-
Currently, Reactime supports React apps using stateful components and Hooks, with beta support for Recoil and Context API.
46+
Currently, Reactime supports React apps using stateful components and Hooks, including frameworks like Gatsby and Next.js, with beta support for Recoil and Context API.
4747

4848
<b>Reactime version 7.0</b> beta can help you to avoid unnecessary re-renders. Identifying wasted renders in your React applications is the perfect start to identifying most performance issues.
4949
Reactime 7.0 fixes previous version bugs and incorporates improved visualizations for component relationships. Reactime 7.0 includes expanded [typedoc](https://typedoc.org/api/) documentation for developers looking to contribute to the source code.
5050

5151
After installing Reactime, you can test its functionalities with your React application in development mode.
5252

53-
Please note, the time jumping feature will ONLY work when your application is running in development mode. In production mode, you are able to view your application’s component map but no additional features.
53+
Please note, the time jumping feature will <b>ONLY</b> work when your application is running in <b>development mode</b>. In production mode, you are able to view your application’s component map but no additional features.
5454

5555
## <b>Installation</b>
5656

@@ -88,6 +88,12 @@ Reactime is an open source project, and we’d really appreciate your help with
8888

8989
One of the most common issues that affects performance in React is unnecessary render cycles. This problem can be fixed by checking your renders in the Performance tab in Chrome DevTools under the Reactime panel.
9090

91+
### Gatsby
92+
Reactime offers fully support for Gatsy applications. You would be able to identify unnecessary renders, duration of each rendering, travel-debugging features and visual representation of the tree components.
93+
94+
### Next.js
95+
Reactime offers debugging and performance tools for Next.js apps: time-traveling debugging, preventing unnecessary components re-renders and making your application faster.
96+
9197
### Recording
9298

9399
Whenever state is changed (whenever setState, useState is called), this extension will create a snapshot of the current state tree and record it. Each snapshot will be displayed in Chrome DevTools under the Reactime panel.
@@ -107,6 +113,11 @@ Reactime offers beta support for TypeScript applications using stateful class co
107113
### Documentation
108114

109115
After cloning this repository, developers can simply run `npm run docs` at the root level and serve the dynamically generated `/docs/index.html` file on a browser. Doing so will provide a readable, extensible, and interactive GUI view of the structure and interfaces of the codebase.
116+
<br>
117+
<p align="center">
118+
<img src="./assets/nextjs.gif" />
119+
</p>
120+
<br>
110121

111122
### <b>Additional Features</b>
112123

assets/nextjs.gif

17.6 MB
Loading

0 commit comments

Comments
 (0)