Skip to content

Commit 79b779e

Browse files
committed
modified readme
1 parent 463a1b9 commit 79b779e

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

readme.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@ npm i reactime
3434
3. Call the library method on your root container after rendering your App.
3535

3636
```
37-
const reactTimeTravel = require('reactime');
37+
const reactime = require('reactime');
3838
3939
const rootContainer = document.getElementById('root');
4040
ReactDom.render(<App />, rootContainer);
4141
42-
reactTimeTravel(rootContainer);
42+
reactime(rootContainer);
4343
```
4444

4545
4. Done! That's all you have to do to link your React project to our library.
@@ -48,7 +48,7 @@ reactTimeTravel(rootContainer);
4848

4949
After installing both the Chrome extension and the npm package, just open up your project in the browser.
5050

51-
Then open up your Chrome DevTools. There'll be a new tab called reactime.
51+
Then open up your Chrome DevTools. There'll be a new tab called Reactime.
5252

5353
## Features
5454

@@ -58,13 +58,11 @@ Whenever state is changed (whenever setState is called), this extension will cre
5858

5959
### Viewing
6060

61-
You can click on a snapshot to view your app's state. State can be visualized in a JSON or a tree.
62-
63-
The selected snapshot can also be diffed/compared with the current dom.
61+
You can click on a snapshot to view your app's state. State can be visualized in a JSON or a tree. Also, snapshots can be diffed with the previous snapshot, which can be viewed under the Diff tab.
6462

6563
### Jumping
6664

67-
The most important feature of all. Jumping to any previous recorded snapshot. Hitting the jump button on any snapshot will change the dom by setting their state. One important thing to note. This library does not work well when mixing React with direct DOM manipulation. Since DOM manipulation doesn't change any React state, this library cannot record or even detect that change. Of course, you should be avoiding mixing the two in the first place.
65+
Jumping is the most important feature of all. It allows you to jump to any previous recorded snapshots. Hitting the jump button on any snapshot will change the DOM by setting their state. One important thing to note is that this library does not work well when mixing React with direct DOM manipulation. Since DOM manipulation doesn't change any React state, this library cannot record or even detect that change. Of course, you should be avoiding mixing the two in the first place.
6866

6967
### Others
7068

@@ -75,7 +73,7 @@ Other handy features include:
7573
- a play button to move through snapshots automatically
7674
- a pause which button stops recording each snapshot
7775
- a lock button to freeze the DOM in place. setState will lose all functionality while the extension is locked
78-
- a persist button to keep snapshots upon refresh. handy when changing code and debugging
76+
- a persist button to keep snapshots upon refresh (handy when changing code and debugging)
7977
- export/import the current snapshots in memory
8078

8179
## Authors

0 commit comments

Comments
 (0)