|
4 | 4 |
|
5 | 5 | <h1 align="center"><b>State Debugger for React</b></h1>
|
6 | 6 |
|
7 |
| -[](https://github.com/oslabs-beta/reactime) [](https://travis-ci.com/oslabs-beta/reactime) [](http://badge.fury.io/js/reactime) [](https://david-dm.org/oslabs-beta/reactime#info=dependencies) [](https://david-dm.org/oslabs-beta/reactime?type=dev) [](https://snyk.io/test/github/oslabs-beta/reactime) |
| 7 | +[](https://github.com/oslabs-beta/reactime) [](https://travis-ci.com/oslabs-beta/reactime) [](http://badge.fury.io/js/reactime) [](https://david-dm.org/oslabs-beta/reactime#info=dependencies) [](https://david-dm.org/oslabs-beta/reactime?type=dev) [](https://snyk.io/test/github/oslabs-beta/reactime) |
8 | 8 |
|
9 |
| - |
10 |
| - |
| 9 | + |
| 10 | + |
11 | 11 |
|
12 | 12 | 👑 Nominated for the Productivity Booster award at [React Open Source Awards 2020](https://osawards.com/react/)! 👑
|
13 | 13 |
|
14 | 14 |
|
15 |
| -<b>Reactime</b> is a debugging tool for React developers. It records state whenever it is changed and allows the user to jump to any previously recorded state. |
| 15 | +<b>Reactime</b> is a 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. |
16 | 16 |
|
17 |
| -Reactime is for React apps using stateful components and Hooks, with beta support for Recoil and Context API. |
| 17 | +Currently, Reactime supports React apps using stateful components and Hooks, with beta support for Recoil and Context API. |
18 | 18 |
|
19 | 19 | Reactime 5.0 beta extends the core functionality by including support for [Recoil](https://recoiljs.org/). The latest release incorporates additional visualizations for component relationships as well as atom-selector relationships for Recoil applications. Reactime 5.0 includes expanded [typedoc](https://typedoc.org/api/) documentation for developers looking to contribute to the source code.
|
20 | 20 |
|
@@ -58,6 +58,10 @@ Using the actions sidebar, a user can jump to any previous recorded snapshots. H
|
58 | 58 |
|
59 | 59 | Reactime offers beta support for TypeScript applications using stateful class components and functional components. Further testing and development is required for custom hooks, Context API, and Concurrent Mode.
|
60 | 60 |
|
| 61 | +### Documentation |
| 62 | + |
| 63 | +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. |
| 64 | + |
61 | 65 | ### Additional Features
|
62 | 66 |
|
63 | 67 | - hover functionality to view tooltip details on state visualizations
|
|
0 commit comments