Skip to content

Commit 96f515f

Browse files
committed
Adding to readme
1 parent e4c1241 commit 96f515f

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,23 @@
11
# React Rewind : A Time Travel Debugger for React
22
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/reactrewind/react-rewind/pulls) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)<br/>
3-
A time travel debugger tool made to work with react 16.8+.
4-
- useReducer
5-
- useState
6-
React Rewind is in active development. Please follow this repo for contribution guidelines and our development road map.
3+
A time travel debugger tool made to work with React 16.8+, designed to help engineers record and replay user sessions to fix bugs faster.
4+
Debug issues easier by “rewinding” your session instead of having to reproduce the issue until you find the bug
5+
6+
- Press record and start interacting with your application
7+
- Each action will be stored as a unique “event” in time
8+
- Pause your recording and start observing all program activities
9+
- Press play to “rewind” through your recorded actions
10+
- View a real-time playback representation of your application state at any given time
11+
12+
13+
**React Rewind is in active development. Please follow this repo for contribution guidelines and our development road map.**
714
## Getting Started
815

916
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
1017

1118
### Prerequisites
1219

13-
Your application must be using the hooks useReducer or useState for actions to be record.
20+
Your application must be using the hooks useReducer for actions to be record.
1421

1522
### Installing
1623
React Rewind is available as a Chrome extension through the Google Chrome Web Store.

0 commit comments

Comments
 (0)