Bring docs inline with new code

Author: nquinlan

README.md

@@ -14,28 +14,24 @@ This repository contains the source code for a map of the hometowns of anyone wh
 
 ## Technologies used in this project
 
-### NodeJS
+### [GitHub Actions](https://github.com/features/actions)
+GitHub actions allows us to run a [NodeJS script](#nodejs) automatically when a commit is pushed to the project. That script takes all the locations provided and turns them into latitude & longitude coordinates.
 
-The map itself is a Node.js application. Node.js allows us to write full-stack
+### [GitHub Pages](https://pages.github.com/)
+GitHub pages lets us host our map on GitHub as a webpage.
 
-## NPM packages used
+### [NodeJS](https://nodejs.org)
 
-### [express](https://www.npmjs.com/package/express)
+We chose to use NodeJS as the language to turn all the hometown names into coordinates. 
 
-Fast, unopinionated, minimalist web framework for node. This is the framework with which we built the application.
-
-### [dotenv](https://www.npmjs.com/package/dotenv)
+#### [dotenv](https://www.npmjs.com/package/dotenv)
 
 Dotenv is a zero-dependency module that loads environment variables from a `.env` file into `process.env`. Storing configuration in the environment separate from code is based on The Twelve-Factor App methodology.
 
-### [node-geocoder](https://www.npmjs.com/package/node-geocoder)
+#### [node-geocoder](https://www.npmjs.com/package/node-geocoder)
 
 Node library for geocoding and reverse geocoding.
 
-### [ejs](https://www.npmjs.com/package/ejs)
-
-Embedded JavaScript templates
-
 ## Try the application locally, if you want!
 
 ### Google Maps API Key
@@ -56,8 +52,6 @@ Japan
 
 To add a new location, simply append a new line to the locations.txt file
 
-There is also a `locations.txt.example` file that can be used to test the app. Copy its content to locations.txt and restart the app.
-
 ## Running the application:
 
 To run this application locally, you'll need to:
@@ -75,14 +69,19 @@ npm install
 There is a `.env.example` file that can be used to configure the app. Simply create a copy named `.env`
 
 ```txt
-PORT= # Port to be used by the app
 GOOGLE_API_KEY= # Google Maps API KEY
 ```
 
-Now inside the root folder run:
+Now inside the root folder run the following:
 
 ```
-npm start
+npm geocode
 ```
 
-Now you can access locally in your browser the address `http://localhost:3000` and see your locations map.
+This will turn each line in the `locations.txt` into a set of coordinates.
+
+You can see your own map by running:
+
+```
+npm start
+```

geocode.js

@@ -1,6 +1,5 @@
 require("dotenv").config();
 const path = require("path");
-const util = require("util");
 
 const Storage = require("./src/storage");
 const Locations = require("./src/locations");

package.json

@@ -7,6 +7,7 @@
     "doc": "docs"
   },
   "scripts": {
+    "start": "npx static-server",
     "geocode": "node geocode.js"
   },
   "engines": {
@@ -28,5 +29,8 @@
     "express": "^4.16.4",
     "morgan": "^1.9.1",
     "node-geocoder": "^3.22.0"
+  },
+  "devDependencies": {
+    "static-server": "^2.2.1"
   }
 }