Merge pull request #163 from dubalol/master

Readme and updated manifest

Author: abaaskhorrami

package/demo.gif

@@ -4,37 +4,33 @@
 
 <h1 align="center">State Debugger for React</h1>
 
-[![GitHub](https://img.shields.io/github/license/oslabs-beta/reactime)](https://github.com/oslabs-beta/reactime)
-[![Build Status](https://travis-ci.com/oslabs-beta/reactime.svg?branch=master)](https://travis-ci.com/oslabs-beta/reactime)
-[![npm version](https://badge.fury.io/js/reactime.svg)](http://badge.fury.io/js/reactime)
-[![Dependencies](https://david-dm.org/oslabs-beta/reactime.svg)](https://david-dm.org/oslabs-beta/reactime#info=dependencies)
-[![DevDependencies](https://david-dm.org/oslabs-beta/reactime/dev-status.svg)](https://david-dm.org/oslabs-beta/reactime?type=dev)
-[![Vulnerabilities](https://snyk.io/test/github/oslabs-beta/reactime/badge.svg)](https://snyk.io/test/github/oslabs-beta/reactime)
+[![GitHub](https://img.shields.io/github/license/oslabs-beta/reactime)](https://github.com/oslabs-beta/reactime) [![Build Status](https://travis-ci.com/oslabs-beta/reactime.svg?branch=master)](https://travis-ci.com/oslabs-beta/reactime) [![npm version](https://badge.fury.io/js/reactime.svg)](http://badge.fury.io/js/reactime) [![Dependencies](https://david-dm.org/oslabs-beta/reactime.svg)](https://david-dm.org/oslabs-beta/reactime#info=dependencies) [![DevDependencies](https://david-dm.org/oslabs-beta/reactime/dev-status.svg)](https://david-dm.org/oslabs-beta/reactime?type=dev) [![Vulnerabilities](https://snyk.io/test/github/oslabs-beta/reactime/badge.svg)](https://snyk.io/test/github/oslabs-beta/reactime)
 
-<p align="center">
-<a href="https://nodei.co/npm/reactime/"><img src="https://nodei.co/npm/reactime.png"></a>
 
-  <img src="demo.gif" alt="Demo of Reactime" style="width: 55%">
-</p>
+![demo](./demo.gif)
+
 
-Reactime is a debugging tool for React developers. It records state whenever it is changed and allows the user to jump to any previously recorded state.
 
-This dev tool is for React apps using stateful components and prop drilling, and has beta support for Context API, conditional state routing, Hooks (useState & useEffect) and functional components.
+Reactime is a debugging tool for React developers. It records state whenever it is changed and allows the user to jump to any previously recorded state.
 
-One thing to note is that this library does not work well when mixing React with direct DOM manipulation.
+This tool is for React apps using stateful components and prop drilling, and has beta support for Context API, conditional state routing, Hooks (useState, useEffect) and functional components.
 
-Two parts are needed for this tool to function. The [**chrome extension**](https://chrome.google.com/webstore/detail/react-time-travel/cgibknllccemdnfhfpmjhffpjfeidjga) must be installed, and the [**NPM package**](https://www.npmjs.com/package/reactime) must be installed and used in the React code.
+The latest release extends the core functionality by including support for TypeScript applications, improving the user experience through more declarative titles in the actions panel, and extending support for components with conditional state fields. The testing suite has also been expanded with the inclusion of a Sandbox utility to aid future expansion as well as additional E2E and integration tests with Puppeteer and React Testing Library.
 
-After successfully installing the chrome extension, you can test Reactime functionalities in the demo repositories below.
+After installing the Reactime, you can test its functionalities in the following demo repositories:
 
-- [Calculator](http://reactime-demo1.us-east-1.elasticbeanstalk.com)
+- [Calculator](https://joshua0308.github.io/calculator/)
 - [Bitcoin Price Index](http://reactime-demo2.us-east-1.elasticbeanstalk.com)
 
-## Installing
+Reactime was nominated for the Productivity Booster award at [React Open Source Awards 2020](https://osawards.com/react/)!
+
+## Installation
 
-1. Download the [extension](https://chrome.google.com/webstore/detail/reactime/cgibknllccemdnfhfpmjhffpjfeidjga) from Chrome Web Store.
+Two parts are required for this tool to function: a [**Chrome extension**](https://chrome.google.com/webstore/detail/react-time-travel/cgibknllccemdnfhfpmjhffpjfeidjga) and an [**NPM package**](https://www.npmjs.com/package/reactime).
 
-2. Install the [npm package](https://www.npmjs.com/package/reactime) in your code.
+1. Install the Reactime [extension](https://chrome.google.com/webstore/detail/reactime/cgibknllccemdnfhfpmjhffpjfeidjga) from Chrome Web Store. Alternatively, use `src/extension/build/build.zip` for manual installation in [Developer mode](https://developer.chrome.com/extensions/faq#faq-dev-01). Turn on 'Allow access to file URLs' in extension details page if testing locally.
+
+2. Install the [NPM package](https://www.npmjs.com/package/reactime) in your application's root directory. 
 
 ```
 npm i reactime
@@ -43,21 +39,31 @@ npm i reactime
 3. Call the library method on your root container after rendering your App.
 
 ```
-const reactime = require('reactime');
+import reactime from 'reactime';
 
 const rootContainer = document.getElementById('root');
 ReactDOM.render(<App />, rootContainer);
 
 reactime(rootContainer);
 ```
 
-4. Done! That's all you have to do to link your React project to our library.
+4. For experimental concurrent mode support.
+
+```
+import reactime from 'reactime';
+
+const rootContainer = ReactDOM.createRoot(document.getElementById('root'));
+rootContainer.render(<App />);
+reactime(rootContainer);
+```
+
+5. Done! That's all you have to do to link your React project to our library.
 
 ## How to Use
 
-After installing both the Chrome extension and the npm package, just open up your project in the browser.
+After installing both the Chrome extension and the NPM package, just open up your project in the browser.
 
-Then open up your Chrome DevTools. There'll be a new tab called Reactime.
+Then open up your Chrome DevTools and navigate to the Reactime tab.
 
 ## Features
 
@@ -73,7 +79,11 @@ You can click on a snapshot to view your app's state. State can be visualized in
 
 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.
 
-### And Much More
+### TypeScript Support
+
+Reactime offers beta support for TypeScript applications using stateful class components and functional components with useState hooks.  Further testing and development is required for custom hooks, Context API, and Concurrent Mode.
+
+### Additional Features
 
 - multiple tree graph branches depicting state changes
 - tree graph hover functionality to view state changes
@@ -85,6 +95,9 @@ Jumping is the most important feature of all. It allows you to jump to any previ
 - a lock button to freeze the DOM in place. setState will lose all functionality while the extension is locked
 - a persist button to keep snapshots upon refresh (handy when changing code and debugging)
 - export/import the current snapshots in memory
+- declarative titles in the actions panel
+- extended support for components with conditional state fields
+- a Sandbox utility to aid future expansion
 
 ## Authors
 
@@ -100,7 +113,12 @@ Jumping is the most important feature of all. It allows you to jump to any previ
 - **Rajeeb Banstola** - [@rajeebthegreat](https://github.com/rajeebthegreat)
 - **Prasanna Malla** - [@prasmalla](https://github.com/prasmalla)
 - **Rocky Lin** - [@rocky9413](https://github.com/rocky9413)
+- **Abaas Khorrami** - [@dubalol](https://github.com/dubalol)
+- **Ergi Shehu** - [@Ergi516](https://github.com/ergi516)
+- **Raymond Kwan** - [@rkwn](https://github.com/rkwn)
+- **Joshua Howard** - [@Joshua-Howard](https://github.com/joshua-howard)
 
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
+

package/readme.md

@@ -22,11 +22,13 @@ After installing the Reactime, you can test its functionalities in the following
 - [Calculator](https://joshua0308.github.io/calculator/)
 - [Bitcoin Price Index](http://reactime-demo2.us-east-1.elasticbeanstalk.com)
 
+Reactime was nominated for the Productivity Booster award at [React Open Source Awards 2020](https://osawards.com/react/)!
+
 ## Installation
 
 Two parts are required for this tool to function: a [**Chrome extension**](https://chrome.google.com/webstore/detail/react-time-travel/cgibknllccemdnfhfpmjhffpjfeidjga) and an [**NPM package**](https://www.npmjs.com/package/reactime).
 
-1. Install the Reactime [extension](https://chrome.google.com/webstore/detail/reactime/cgibknllccemdnfhfpmjhffpjfeidjga) from Chrome Web Store. Alternatively, a [**zipped version**](build.zip) has been provided in `build.zip` for manual installation in [Developer mode](https://developer.chrome.com/extensions/faq#faq-dev-01). Turn on 'Allow access to file URLs' in extension details page if testing locally.
+1. Install the Reactime [extension](https://chrome.google.com/webstore/detail/reactime/cgibknllccemdnfhfpmjhffpjfeidjga) from Chrome Web Store. Alternatively, use `src/extension/build/build.zip` for manual installation in [Developer mode](https://developer.chrome.com/extensions/faq#faq-dev-01). Turn on 'Allow access to file URLs' in extension details page if testing locally.
 
 2. Install the [NPM package](https://www.npmjs.com/package/reactime) in your application's root directory. 
 

readme.md

@@ -1,6 +1,6 @@
 {
   "name": "Reactime",
-  "version": "3.2",
+  "version": "3.3",
   "devtools_page": "devtools.html",
   "description": "A Chrome extension that helps debug React applications by memorizing the state of components with every render.",
   "manifest_version": 2,