Skip to content

Commit d76f1a2

Browse files
committed
Clean DeveloperREADME and add Redux devtools integration documentation
1 parent d08dd71 commit d76f1a2

File tree

2 files changed

+21
-14
lines changed

2 files changed

+21
-14
lines changed

DeveloperREADME.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,45 +7,52 @@ Development Enviroment Setup
77
Getting Started
88
<h2>
99

10-
<h4>1. Download React Dev Tools from the Chrome Webstore <a href=https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en>
11-
Click Here To Download
10+
<h4>1. <a href=https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en>
11+
Download React Dev Tools from the Chrome Webstore Here
1212
</a></h4>
1313

1414
<h4>2. Clone down the Reactime repo onto your machine.</h4>
1515

16-
`````
16+
```
1717
git clone https://github.com/open-source-labs/reactime.git
18-
`````
18+
```
1919

2020
<h4> 3. Install dependencies and build.</h4>
2121

22-
`````
22+
```
2323
cd reactime
2424
npm install --force
2525
npm run build
26-
`````
26+
```
27+
2728
<h4> 4. Spin up the demo application. </h4>
2829

29-
`````
30+
```
3031
cd demo-app
3132
npm install
3233
npm start
33-
`````
34+
```
35+
3436
<br>
3537

3638
<h4>
3739
5. Add Reactime to your Chrome extensions.
3840
<br>
39-
- Navigate to chrome://extensions
41+
* Navigate to chrome://extensions
4042
<br>
41-
- Select “Load Unpacked”
43+
* Select “Load Unpacked”
4244
<br>
43-
- Choose reactime > src > extension > build
45+
* Choose reactime > src > extension > build
4446
<br>
45-
Navigate to http://localhost:8080/ to inspect the demo application using Reactime!
47+
* Navigate to http://localhost:8080/ to inspect the demo application using Reactime!
4648
<br>
4749
<br>
4850
<h4>
4951
<p align="center">
5052
<img src="./assets/reactime-dev-setup.gif" />
51-
</p>
53+
</p>
54+
<br>
55+
<h2>Documentation for Consideration</h2>
56+
<h4>Can Reactime be integrated with Redux compatibility so applications using Redux can track state in Reactime?
57+
<br>
58+
Yes, but it would be very time-consuming and not the most feasible option while Redux devtools exists already. With how Redux devtools is currently set up, a developer is unable to use Redux devtools as a third-party user and integrate its functionality into their own application, as Redux devtools is meant to be used directly on an application using Redux for state-tracking purposes. Since the devtools do not appear to have a public API for integrated use in an application or it simply does not exist, Redux devtools would need to be rebuilt from the ground up and then integrated into Reactime, or built into Reactime directly still from scratch.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
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-
<b>Reactime 15.0</b> has added a new visualization, allowing users to zone in on individual components of a specific snapshot. Additionally, a number of bug fixes have been implemented.
46+
<b>Reactime 15.0</b> adds a new visualization, allowing users to zone in on individual components of a specific snapshot. Additionally, a number of bug fixes have been implemented.
4747

4848
Currently, Reactime supports React apps (now including React Router apps) using stateful components and Hooks, with beta support for Recoil and Context API and frameworks like Gatsby and Next.js.
4949

0 commit comments

Comments
 (0)