Update readme for presentation

README.md

@@ -1,17 +1,134 @@
-# UFO
-UFO Data Set
+<!-- Application Name -->
+<h1 align="center">UFO Catcher</h1>
 
-Instruction so far:
+<!-- App Description -->
+<div align="center">Web application entices users to view official UFO sighting reports and determine them to be, in fact, "alien," or bogus, "not alien" claims. <em>Do you believe?...</em></div>
 
-1. Check local mysql for database `UFO`
-2. run `npm install`
-3. `sequelize init:models & sequelize init:config`
-4. If the above doesn't work, try `npm install -g sequelize sequelize-cli`
-5. run `node server`
 
-Table with content should be created. To import from the UFO dataset on Sequel PRO 
-1. Go to UFO database
-2. Check you are on the table UFO
-3. cmd + shift + i (or File> Import) and select the csv file. 
+## Contents
+  - [Contents](#contents)
+    - [Deployed Application](#deployed-application)
+    - [Inspiration](#inspiration)
+    - [Roles](#roles)
+    - [Technologies Used](#technologies-used)
+    - [Concept & Motivation](#concept-motivation)
+    - [Challenges](#challenges)
+    - [Future Features](#future-features)
+    - [Credits](#credits)
 
-4. To add an id `ALTER TABLE tbl ADD id INT PRIMARY KEY AUTO_INCREMENT;`
+
+
+## Deployed Application
+[Heroku] https://fast-eyrie-14169.herokuapp.com/
+
+
+
+## Inspiration
+National UFO Reporting Center "UFO Sightings" Database
+
+[Kaggle] https://www.kaggle.com/NUFORC/ufo-sightings
+
+
+
+## Roles
+  * Jessica Lin - Co-COO, UI Director, Back-end
+    * Threejs & environment design
+    * Chart.js & required API-routes
+    * Navigation bar
+  * Laura Boetcher - Co-COO, Back-end, SVG Apprentice
+    * Sequelize API-routes for voting
+    * Voting functionality
+    * Session-based vote log
+
+
+
+## Technologies Used
+  Node, Express, MySQL, Sequelize, Threejs, Chart.js, Maya (JsonLoader), SVG, jQuery, Javascript, CSS, HTML
+
+
+
+## Concept & Motivation
+  * Voting
+    <!-- * Laura -->
+  * Feel (music/visuals)
+    <!-- * Jess -->
+  * Text (ASCII/terminal look)
+    <!-- * Laura -->
+  * Discovery
+    <!-- * Jess -->
+
+
+
+## Challenges
+
+### Threejs
+
+
+### Sequelize
+
+
+### Cursor
+  ###### Hand cursor on mouse hover
+  ![light-cursor](screenshots/light_cursor.gif)
+
+### Animated Effects
+  ###### Glitch effect on application title
+  ![title-glitch](screenshots/title_glitch.gif)
+  ***
+  ###### Glitch effect on message
+  ![subtitle-glitch](screenshots/subtitle_glitch.gif)
+  ***
+  ###### Snackbar popup "vote logged"
+  ![entry-logged](screenshots/entry_logged.gif)
+
+
+
+#### Abandoned elements
+  * Upvote (jQuery plugin)
+  * NProgress (javascript progress bar)
+  * Barba.js
+  * User-submitted data
+  * Animated screen loader
+  * SVG button effects
+
+  ###### Animated SVG "cow loader"
+  ![dizzy-cow](screenshots/dizzy_cow.gif)
+  ***
+
+  ###### SVG with gitch effect
+  ![svg-glitch](screenshots/svg_glitch.gif)
+  ***
+
+  ###### SVG in `<object>` tag, uses css `fill` property on hover
+  ![button-hover-test](screenshots/button_hover.gif)
+
+
+
+## Future Features
+  * User authentication
+    * User can mark favorite entries
+    * User can add own sighting data
+    * User can fork comments, edit for spelling, etc.
+  * Newspaper image generator
+    * Render headlines of favorite/ most popular entries
+    * Shareable/printable
+  * Interactive graphics
+    * Spacecraft changes color, lighting, etc.
+    * Little green men to make appearances
+    * Additional clickable elements
+  * eCommerce integration
+    * "I Voted" stickers
+    * Fashionable aluminum hats
+    * "UFO Catcher" branded binoculars, t-shirts, etc.
+
+
+
+### Credits
+  * CSS Glitch Effect by Chris Coyier (https://codepen.io/chriscoyier/pen/yqHxB)
+  * Interactive Solar System by  Nikita Skargovskii (https://codepen.io/nikita_ska/pen/bqNdBj)
+  * Music from Ambient Epicuros (https://www.youtube.com/watch?v=ORNfEC1q2EU&t=511s)
+  * Banner Alien Icons by corpus delicti on Noun Project (https://thenounproject.com/term/banner-alien/1040564/)
+  * StackOverflow
+  * Codyhouse
+  * CodePen
+  * Curious aliens visiting Earth