update README.md and cleanup files

.gitignore

@@ -1,9 +1,5 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
-
 # dependencies
 /node_modules
-/.pnp
-.pnp.js
 
 # testing
 /coverage

README.md

@@ -1,29 +1,62 @@
-Sceneform SDK for Android
-=====================
-Copyright (c) 2018 Google Inc.  All rights reserved.
 
-Sceneform is a 3D framework, with a physically based renderer, that's optimized for mobile, and that makes it easy for Java developers to build augmented reality apps.
+<img src="./media/live_subtitles_logo.png" alt="drawing" width="200"/>
+# [Live Subtitles](https://github.com/rogerwangcs/ar-dialogue-subtitles)
+> Display what people are saying as they are talking in real time!
+> A quick app built by David Shen, Roger Wang, Jerry Han, and Alex Sun.
+> Created using React, Tensorflow.js, and Chrome's speech-to-text API.
 
-Please note, we do not accept pull requests.
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![HitCount](http://hits.dwyl.io/rogerwangcs/ar-dialogue-subtitles.svg)](http://hits.dwyl.io/rogerwangcs/ar-dialogue-subtitles)
 
+<!-- ![GIF](https://media.giphy.com/media/fXbUMQite0B2xQ6HMK/giphy.gif)
+[See full video demonstration here](https://www.youtube.com/watch?v=J0t2Kvortio&feature=youtu.be) -->
+
+<p align="center">
+  <img src="https://media.giphy.com/media/fXbUMQite0B2xQ6HMK/giphy.gif" stylealt="video"/>
+</p>
+<p align="center">
+  <a href="https://www.youtube.com/watch?v=J0t2Kvortio&feature=youtu.be">See Full Video Demonstration!</a>
+</p>
+<p align="center">
+  <img src="./media/image-demo.png" stylealt="image demo" width="800"/>
+</p>
+<p align="center">
+  <img src="./media/face-mesh.png" stylealt="face mesh demo" width="800"/>
+</p>
+
+---
 
 ## Getting Started
 
-This repository contains Sceneform sample projects.
+- All the `code` required to get started
+- Images of what it should look like
+
+### Clone
 
-To get started with the Sceneform SDK, follow the ARCore [Android Quickstart](//developers.google.com/ar/develop/java/quickstart) guide.
+- Clone this repo to your local machine
+`git clone https://github.com/rogerwangcs/ar-dialogue-subtitles.git`
 
+### Setup
 
-## API Reference
+##### Install dependencies
+`yarn install` or `npm install`
 
-See the [Sceneform API Reference](//developers.google.com/ar/reference/java/com/google/ar/sceneform/package-summary).
 
+##### Install dependencies
+`yarn install` or `npm install`
 
-## Release Notes
+### Run
+`yarn start` or `npm npm start`
 
-The SDK release notes are available on the [releases](//github.com/google-ar/sceneform-android-sdk/releases) page.
+Enjoy!
 
+---
 
-## Terms & Conditions
+## Contributors
+- [Roger Wang](https://github.com/rogerwangcs)
+- [David Shen](https://github.com/pantherman594)
+- [Jerry Han](https://github.com/sparkyman173)
+- [Alexander Sun](https://github.com/technoAl)
 
-By downloading the Sceneform SDK for Android, you agree that the [Google APIs Terms of Service](//developers.google.com/terms/) governs your use thereof.
+---
+## License
+- **[MIT license](http://opensource.org/licenses/mit-license.php)**

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "web-dialogue-subtitles",
-  "version": "0.1.0",
+  "name": "ar-dialogue-subtitles",
+  "version": "1.0.0",
   "private": true,
   "dependencies": {
     "@tensorflow/tfjs-node": "^1.0.3",
@@ -15,9 +15,7 @@
   },
   "scripts": {
     "start": "react-scripts start",
-    "build": "react-scripts build",
-    "test": "react-scripts test",
-    "eject": "react-scripts eject"
+    "build": "react-scripts build"
   },
   "eslintConfig": {
     "extends": "react-app"

public/index.html

@@ -8,36 +8,13 @@
       content="width=device-width, initial-scale=1, shrink-to-fit=no"
     />
     <meta name="theme-color" content="#000000" />
-
     <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
-    <!--
-      manifest.json provides metadata used when your web app is installed on a
-      user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
-    -->
     <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
-    <!--
-      Notice the use of %PUBLIC_URL% in the tags above.
-      It will be replaced with the URL of the `public` folder during the build.
-      Only files inside the `public` folder can be referenced from the HTML.
-
-      Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
-      work correctly both with client-side routing and a non-root public URL.
-      Learn how to configure a non-root public URL by running `npm run build`.
-    -->
     <title>Live Subtitles</title>
+
   </head>
   <body>
     <noscript>You need to enable JavaScript to run this app.</noscript>
     <div id="root"></div>
-    <!--
-      This HTML file is a template.
-      If you open it directly in the browser, you will see an empty page.
-
-      You can add webfonts, meta tags, or analytics to this file.
-      The build step will place the bundled scripts into the <body> tag.
-
-      To begin the development, run `npm start` or `yarn start`.
-      To create a production bundle, use `npm run build` or `yarn build`.
-    -->
   </body>
 </html>