Merge pull request #102 from oslabs-beta/rydang-patch-1

replaced package readme

Author: mylee1995

package/readme.md

@@ -1,20 +1,26 @@
 # Reactime
 
-![GitHub](https://img.shields.io/github/license/oslabs-beta/reactime) 
-![Travis (.com) branch](https://img.shields.io/travis/com/oslabs-beta/reactime/dev?label=dev%20build)
-![Travis (.com) branch](https://img.shields.io/travis/com/oslabs-beta/reactime/master?label=master%20build)
-![npm](https://img.shields.io/npm/v/reactime?color=green)
-![David](https://img.shields.io/david/oslabs-beta/reactime)
-![DevDependencies](https://img.shields.io/david/dev/oslabs-beta/reactime.svg)
-![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/oslabs-beta/reactime)
+[![GitHub](https://img.shields.io/github/license/oslabs-beta/reactime)](https://github.com/oslabs-beta/reactime)
+[![Build Status](https://secure.travis-ci.org/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)
+
+[![NPM](https://nodei.co/npm/reactime.png)](https://nodei.co/npm/reactime/)
 
 <p align="center">
-  <img src="demo.gif" alt="Demo of Reactime">
+  <img src="demo2.gif" alt="Demo of Reactime" style="width: 55%">
 </p>
 
 A debugging tool for React. Records state whenever state is changed and allows user to jump to any previous recorded state.
 
-Two parts are needed for this tool to function. The chrome extension must be installed, and the NPM package must be installed and used in the React code.
+Two parts are needed for this tool to function. The <a href="https://chrome.google.com/webstore/detail/react-time-travel/cgibknllccemdnfhfpmjhffpjfeidjga">chrome extension</a> must be installed, and the NPM package must be installed and used in the React code.
+
+After successfully installing the chrome extension, you can test Reactime functionalities in the demo repositories below.
+
+- <a href="http://reactime-demo1.us-east-1.elasticbeanstalk.com/">Calculator</a>
+- <a href="http://reactime-demo2.us-east-1.elasticbeanstalk.com/"> Bitcoin Price Index</a>
 
 ## Installing
 
@@ -29,12 +35,12 @@ npm i reactime
 3. Call the library method on your root container after rendering your App.
 
 ```
-const reactTimeTravel = require('reactime');
+const reactime = require('reactime');
 
 const rootContainer = document.getElementById('root');
 ReactDom.render(<App />, rootContainer);
 
-reactTimeTravel(rootContainer);
+reactime(rootContainer);
 ```
 
 4. Done! That's all you have to do to link your React project to our library.
@@ -43,7 +49,7 @@ reactTimeTravel(rootContainer);
 
 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. There'll be a new tab called Reactime.
 
 ## Features
 
@@ -53,13 +59,11 @@ Whenever state is changed (whenever setState is called), this extension will cre
 
 ### Viewing
 
-You can click on a snapshot to view your app's state. State can be visualized in a JSON or a tree.
-
-The selected snapshot can also be diffed/compared with the current dom.
+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.
 
 ### Jumping
 
-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.
+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.
 
 ### Others
 
@@ -70,7 +74,7 @@ Other handy features include:
 - a play button to move through snapshots automatically
 - a pause which button stops recording each snapshot
 - 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
+- a persist button to keep snapshots upon refresh (handy when changing code and debugging)
 - export/import the current snapshots in memory
 
 ## Authors