Skip to content

Commit 35830a7

Browse files
authored
Merge pull request #20 from christinaor/c-feature-branch
Clean DeveloperREADME and add Redux devtools integration documentation
2 parents 18ca356 + 57da5cb commit 35830a7

File tree

2 files changed

+27
-34
lines changed

2 files changed

+27
-34
lines changed

DeveloperREADME.md

Lines changed: 26 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,44 @@
11
<div>
2-
<h1>
3-
Development Enviroment Setup
4-
<h1>
2+
<h1>Development Enviroment Setup</h1>
53

6-
<h2>
7-
Getting Started
8-
<h2>
4+
<h2>Getting Started</h2>
95

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
12-
</a></h4>
6+
1. <a href="https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en">Download React Dev Tools from the Chrome Webstore Here</a>
137

14-
<h4>2. Clone down the Reactime repo onto your machine.</h4>
8+
2. Clone down the Reactime repo onto your machine.
159

16-
`````
10+
```
1711
git clone https://github.com/open-source-labs/reactime.git
18-
`````
12+
```
1913

20-
<h4> 3. Install dependencies and build.</h4>
14+
3. Install dependencies and build.
2115

22-
`````
16+
```
2317
cd reactime
2418
npm install --force
2519
npm run build
26-
`````
27-
<h4> 4. Spin up the demo application. </h4>
20+
```
2821

29-
`````
22+
4. Spin up the demo application.
23+
24+
```
3025
cd demo-app
3126
npm install
3227
npm start
33-
`````
34-
<br>
28+
```
3529

36-
<h4>
3730
5. Add Reactime to your Chrome extensions.
38-
<br>
39-
- Navigate to chrome://extensions
40-
<br>
41-
- Select “Load Unpacked”
42-
<br>
43-
- Choose reactime > src > extension > build
44-
<br>
45-
Navigate to http://localhost:8080/ to inspect the demo application using Reactime!
46-
<br>
47-
<br>
48-
<h4>
31+
32+
- Navigate to chrome://extensions
33+
- Select “Load Unpacked”
34+
- Choose reactime > src > extension > build
35+
- Navigate to http://localhost:8080/ to inspect the demo application using Reactime!
36+
<br>
37+
4938
<p align="center">
50-
<img src="./assets/reactime-dev-setup.gif" />
51-
</p>
39+
<img src="./assets/reactime-dev-setup.gif" />
40+
</p>
41+
42+
<h2>Documentation for Consideration</h2>
43+
<h4>Can Reactime be integrated with Redux compatibility so applications using Redux can track state in Reactime?</h4>
44+
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)