Merge pull request #75 from kiacolbert/readme

Readme

Author: victorvrv

LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 React Rewind <reactrewindjs@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,65 @@
+![alt text](./images/greygreen_gg_full_350w.png)
+
+# React Rewind : A Time Travel Debugger for React
+[![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/>
+A time travel debugger for React's useReducer hook, designed to help engineers record and replay user sessions to fix bugs faster.
+Debug issues easier by “rewinding” your session instead of having to reproduce the issue until you find the bug.
+
+- Press record and start interacting with your application
+- Each dispatched action will be stored as a unique “event” in time
+- Rewind through your recorded actions with back buttom
+- Press play to view your changing app state 
+
+
+ **React Rewind is in active development. Please follow this repo for contribution guidelines and our development road map.**
+## Getting Started
+
+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.
+
+### Prerequisites
+Your application must be using the hook useReducer for actions to be record.
+
+### Installing
+React Rewind is available as a Chrome extension through the Google Chrome Web Store.
+On your application page open Chrome Developer tools and select React Rewind from the tool bar. 
+Click `Record` and begin interacting with your application.
+
+If you prefer to install locally, setup instructions are as follows:
+```
+git clone https://github.com/reactrewind/react-rewind.git
+cd reactrewind
+npm install
+npm run rewind
+```
+
+Then head to [chrome://extensions/](chrome://extensions/)<br/>
+Click `Load Unpacked` button and upload the chrome folder, located at react-rewind/src/browser/chrome.<br/>
+On your application page open Chrome Developer tools and select React Rewind from the tool bar. <br/>
+Click `Record` and begin interacting with your application.
+
+
+As you interact with your application actions will populate in the events panel.  These actions are clickable and will change the state of your page. The actions can be viewed in more detail in the right panel by inspecting the actions, effects, and state.  The time slider panel allows you to rewind, fast forward,and play through all recorded actions.
+
+### The UI
+|Property  | Description |
+| ------------- | ------------- |
+| Events  |  Dispatched actions (three ways to view see below)  <br/>Shows elapsed time since last dispatch |
+|Actions  | Events action type and payload  |
+|Effects  | Difference between selected event and previous state  |
+|State  | Overall state of the application at the selected time  |
+## Contributing
+
+Please fork this repo.  We welcome pull requests. For suggestions or to report bugs please log an issue.
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). 
+
+## Authors
+
+[Brandon Murphy](https://github.com/murphybrandon) | [Victor Varaschin](https://github.com/victorvrv) | [Kia Colbert](https://github.com/kiacolbert) | [Gabor Mowiena](https://github.com/GaberMowiena)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](./LICENSE) file for details
+