Merge pull request #283 from open-source-labs/Joseph-UpdateReadMe

Updating ReadMe for launch

DeveloperREADME.md

@@ -7,31 +7,45 @@ Development Enviroment Setup
 Getting Started 
 <h2>
 
-<h4>
-1. Download React Dev Tools from the Chrome Web Store.  <a href=https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en>
+<h4>1. Download React Dev Tools from the Chrome Webstore <a href=https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en>
 Click Here To Download
-</a>
+</a></h4>
 
-<br>
-2. Run the following command in your terminal.
-<h4>
+<h4>2. Clone down the Reactime repo onto your machine.</h4>
 
 `````
+git clone https://github.com/open-source-labs/reactime.git
+`````
+
+<h4> 3. Install dependencies and build.</h4>
+
+`````
+cd reactime
 npm install --force
+npm run build
+`````
+<h4> 4. Spin up the demo application. </h4>
+
+`````
+cd demo-app
+npm install
+npm start
 `````
-<h4>
-3. If everything was installed without any errors, great! Move on to testing section to make sure everything is running.
-<h4>
 <br>
 
-<h2>
-Testing
-<h2>
 <h4>
-1. Access your Chrome extensions by clicking the puzzle piece icon in your browser. Click on manage extensions on the bottom. From there change into Developer Mode on the top right.
-
+5. Add Reactime to your Chrome extensions.
+<br>
+- Navigate to chrome://extensions
+<br>
+- Select “Load Unpacked”
+<br>
+- Choose reactime > src > extension > build
+<br>
+Navigate to http://localhost:8080/ to inspect the demo application using Reactime!
+<br>
 <br>
-2. Click on "Load unpacked" on the left side of the screen. From there locate the Reactime file, and load  src/extension/build. If loaded correctly you should now see Reactime as an extension.
 <h4>
-
-<div>
+<p align="center">
+<img src="./assets/reactime-dev-setup.gif" />
+</p>

README.fr.md

@@ -131,10 +131,24 @@ Après avoir cloné ce référentiel, les développeurs peuvent simplement exéc
 
 ## <b>Auteurs</b>
 
+- **David Kim** - [@codejunkie7](https://github.com/codejunkie7)
+- **Robby Tipton** - [@RobbyTipton](https://github.com/RobbyTipton)
+- **Kevin HoEun Lee** - [@khobread](https://github.com/khobread)
+- **Christopher LeBrett** - [@fscgolden](https://github.com/fscgolden)
+- **Joseph Park** - [@joeepark](https://github.com/joeepark)
 - **Kris Sorensen** - [@kris-sorensen](https://github.com/kris-sorensen)
 - **Daljit Gill** - [@dgill05](https://github.com/dgill05)
 - **Ben Michareune** - [@bmichare](https://github.com/bmichare)
 - **Dane Corpion** - [@danecorpion](https://github.com/danecorpion)
+- **Harry Fox** - [@StackOverFlowWhereArtThou](https://github.com/StackOverFlowWhereArtThou)
+- **Nathan Richardson** - [@BagelEnthusiast](https://github.com/BagelEnthusiast)
+- **David Bernstein** - [@dangitbobbeh](https://github.com/dangitbobbeh)
+- **Joseph Stern** - [@josephiswhere](https://github.com/josephiswhere)
+- **Dennis Lopez** - [@DennisLpz](https://github.com/DennisLpz)
+- **Cole Styron** - [@colestyron](https://github.com/C-STYR)
+- **Ali Rahman** - [@CourageWolf](https://github.com/CourageWolf)
+- **Caner Demir** - [@demircaner](https://github.com/demircaner)
+- **Kevin Ngo** - [@kev-ngo](https://github.com/kev-ngo)
 - **Becca Viner** - [@rtviner](https://github.com/rtviner)
 - **Caitlin Chan** - [@caitlinchan23](https://github.com/caitlinchan23)
 - **Kim Mai Nguyen** - [@Nkmai](https://github.com/Nkmai)
@@ -169,6 +183,15 @@ Après avoir cloné ce référentiel, les développeurs peuvent simplement exéc
 - **Ergi Shehu** - [@Ergi516](https://github.com/ergi516)
 - **Raymond Kwan** - [@rkwn](https://github.com/rkwn)
 - **Joshua Howard** - [@Joshua-Howard](https://github.com/joshua-howard)
+- **Lina Shin** - [@rxlina](https://github.com/rxlina)
+- **Andy Tsou** - [@andytsou19](https://github.com/andytsou19)
+- **Feiyi Wu** - [@FreyaWu](https://github.com/FreyaWu)
+- **Viet Nguyen** - [@vnguyen95](https://github.com/vnguyen95)
+- **Alex Gomez** - [@alexgomez9](https://github.com/alexgomez9)
+- **Edar Liu** - [@liuedar](https://github.com/liuedar)
+- **Kristina Wallen** - [@kristinawallen](https://github.com/kristinawallen)
+- **Quan Le** - [@blachfog](https://github.com/Blachfog)
+- **Robert Maeda** - [@robmaeda](https://github.com/robmaeda)
 
 ## <b>License </b>
 

README.md

@@ -175,6 +175,11 @@ After cloning this repository, developers can simply run `npm run docs` at the r
 
 ## <b>Authors</b>
 
+- **David Kim** - [@codejunkie7](https://github.com/codejunkie7)
+- **Robby Tipton** - [@RobbyTipton](https://github.com/RobbyTipton)
+- **Kevin HoEun Lee** - [@khobread](https://github.com/khobread)
+- **Christopher LeBrett** - [@fscgolden](https://github.com/fscgolden)
+- **Joseph Park** - [@joeepark](https://github.com/joeepark)
 - **Kris Sorensen** - [@kris-sorensen](https://github.com/kris-sorensen)
 - **Daljit Gill** - [@dgill05](https://github.com/dgill05)
 - **Ben Michareune** - [@bmichare](https://github.com/bmichare)
@@ -231,11 +236,6 @@ After cloning this repository, developers can simply run `npm run docs` at the r
 - **Kristina Wallen** - [@kristinawallen](https://github.com/kristinawallen)
 - **Quan Le** - [@blachfog](https://github.com/Blachfog)
 - **Robert Maeda** - [@robmaeda](https://github.com/robmaeda)
-- **David Kim** - [@codejunkie7](https://github.com/codejunkie7)
-- **Robby Tipton** - [@RobbyTipton](https://github.com/RobbyTipton)
-- **Kevin HoEun. Lee** - [@khobread](https://github.com/khobread)
-- **Christopher LeBrett** - [@fscgolden](https://github.com/fscgolden)
-- **Joseph Park** - [@joeepark](https://github.com/joeepark)
 
 ## <b>License </b>
 

README.rus.md

@@ -107,10 +107,24 @@ Reactime beta поддерживает приложения, написанны
 
 ## <b>Авторы</b>
 
+- **David Kim** - [@codejunkie7](https://github.com/codejunkie7)
+- **Robby Tipton** - [@RobbyTipton](https://github.com/RobbyTipton)
+- **Kevin HoEun Lee** - [@khobread](https://github.com/khobread)
+- **Christopher LeBrett** - [@fscgolden](https://github.com/fscgolden)
+- **Joseph Park** - [@joeepark](https://github.com/joeepark)
 - **Kris Sorensen** - [@kris-sorensen](https://github.com/kris-sorensen)
 - **Daljit Gill** - [@dgill05](https://github.com/dgill05)
 - **Ben Michareune** - [@bmichare](https://github.com/bmichare)
 - **Dane Corpion** - [@danecorpion](https://github.com/danecorpion)
+- **Harry Fox** - [@StackOverFlowWhereArtThou](https://github.com/StackOverFlowWhereArtThou)
+- **Nathan Richardson** - [@BagelEnthusiast](https://github.com/BagelEnthusiast)
+- **David Bernstein** - [@dangitbobbeh](https://github.com/dangitbobbeh)
+- **Joseph Stern** - [@josephiswhere](https://github.com/josephiswhere)
+- **Dennis Lopez** - [@DennisLpz](https://github.com/DennisLpz)
+- **Cole Styron** - [@colestyron](https://github.com/C-STYR)
+- **Ali Rahman** - [@CourageWolf](https://github.com/CourageWolf)
+- **Caner Demir** - [@demircaner](https://github.com/demircaner)
+- **Kevin Ngo** - [@kev-ngo](https://github.com/kev-ngo)
 - **Becca Viner** - [@rtviner](https://github.com/rtviner)
 - **Caitlin Chan** - [@caitlinchan23](https://github.com/caitlinchan23)
 - **Kim Mai Nguyen** - [@Nkmai](https://github.com/Nkmai)
@@ -145,6 +159,15 @@ Reactime beta поддерживает приложения, написанны
 - **Ergi Shehu** - [@Ergi516](https://github.com/ergi516)
 - **Raymond Kwan** - [@rkwn](https://github.com/rkwn)
 - **Joshua Howard** - [@Joshua-Howard](https://github.com/joshua-howard)
+- **Lina Shin** - [@rxlina](https://github.com/rxlina)
+- **Andy Tsou** - [@andytsou19](https://github.com/andytsou19)
+- **Feiyi Wu** - [@FreyaWu](https://github.com/FreyaWu)
+- **Viet Nguyen** - [@vnguyen95](https://github.com/vnguyen95)
+- **Alex Gomez** - [@alexgomez9](https://github.com/alexgomez9)
+- **Edar Liu** - [@liuedar](https://github.com/liuedar)
+- **Kristina Wallen** - [@kristinawallen](https://github.com/kristinawallen)
+- **Quan Le** - [@blachfog](https://github.com/Blachfog)
+- **Robert Maeda** - [@robmaeda](https://github.com/robmaeda)
 
 ## <b>License </b>
 

package.json

@@ -40,16 +40,18 @@
   "contributors": [
     "Abaas Khorrami",
     "Ali Rahman",
-    "Andy Wong",
     "Andy Tsou",
-    "Bryan Lee",
+    "Andy Wong",
     "Becca Viner",
+    "Bryan Lee",
     "Caitlin Chan",
     "Caner Demir",
     "Carlos Perez",
-    "Cole Styron",
     "Chris Flannery",
+    "Christopher LeBrett",
+    "Cole Styron",
     "David Chai",
+    "David Kim",
     "Dennis Lopez",
     "Edwin Menendez",
     "Ergi Shehu",
@@ -59,16 +61,19 @@
     "Haejin Jo",
     "Hien Nguyen",
     "Jack Crish",
+    "Joseph Park",
     "Josh Kim",
     "Joshua Howard",
     "Kevin Fey",
+    "Kevin HoEun Lee",
     "Kevin Ngo",
     "Kim Mai Nguyen",
     "Lina Shin",
     "Nathanael Wa Mwenze",
     "Prasanna Malla",
     "Rajeeb Banstola",
     "Raymond Kwan",
+    "Robby Tipton",
     "Rocky Lin",
     "Ruth Anam",
     "Ryan Dang",
@@ -189,4 +194,4 @@
     "util": "^0.12.4",
     "web-vitals": "^1.1.0"
   }
-}
+}

src/README.md

@@ -35,7 +35,7 @@ src/
 │   ├── module.d.ts           #
 │   ├── package.json          #
 │   ├── puppeteerServer.js    #
-│   ├── routes.ts             # Interfaces with the browser history stack during inter-route time travel in React Router applications.
+│   ├── routes.ts             # Interfaces with the browser history stack 
 │   ├── timeJump.ts           # Rerenders DOM based on snapshot from background script
 │   └── tree.ts               # Custom structure to send to background
 │