Update README

joeltaylor · joeltaylor · commit 6738fe9585e6 · 2015-12-08T23:57:42.000-05:00
diff --git a/README.md b/README.md
@@ -1,49 +1,89 @@
 # JavaScript.com
 
-This is the repo for the JavaScript.com website.
+With the help of community members contributing content to the site,
+JavaScript.com aims to keep developers up to date on news, frameworks, and libraries.
+In addition, we aim to be a gateway for those wanting to learn JavaScript.
 
-## Installing NVM
+# Roadmap
+JavaScript.com was the product of a hack day and there's a lot of room for
+improvement. We have three main areas of focus for v2 of the app.
 
+##### Spec coverage
+If only the amount of console.logs counted as spec coverage, we'd be golden.
+
+##### User Voting
+Instead of approving new posts, we'll allow users to upvote and downvote stories
+as they see fit.
+
+##### Markdown Support
+Life just doesn't feel right without Markdown.
+
+### Contributions
+We'd love for you to contribute! For the time being, we will be placing a strong
+emphasis on getting the code base up to standards before adding new features.
+
+### Deployments
+We have two main branches, `master` and `production`. All PR's will be merged
+into `master` which is then merged into `production. The `production` branch is
+the code that is currenly deployed.
+
+At the moment, `master` is ahead of `production` while we streamline our deploy
+process. Please bear with us for the timing being!
+
+
+# Getting Started
+#### Installing NVM
 Install NVM (`$ brew install nvm` and follow instructions)
 
 ```bash
-nvm install iojs-v1.2.0
-nvm use iojs-v1.2.0
+nvm install 5.0.0
 npm install -g gulp
 npm install
 ```
 
-This app authenticates with GitHub, so you'll need to create a GitHub Application and set ENVs for `GH_CLIENT_ID` and `GH_CLIENT_SECRET`.
-
-## Running
+#### Building Assets
 
-Run the application with `$ npm start`. You can also set the environment variables at start time. Here's an example:
+To build assets locally, you'll need to install Bower dependencies and run these Gulp tasks:
 
 ```bash
-$ GH_CLIENT_ID=myid GH_CLIENT_SECRET=mysecret npm start
+$ bower install
+$ gulp sass
+$ gulp javascript
 ```
+Remember to re-run these tasks after pulling or changing branches.
+
+#### Setup Github Application
+This app authenticates with GitHub, so you'll need to create a
+[GitHub Application](https://github.com/settings/applications/new).
+
+Set the **Homepage URL** to `http://localhost:3000` and
 
-For debugging all the things, run `DEBUG=* npm start`.
+the **Authorization callback URL** to `http://localhost:3000/sessions/auth/github/callback/`
 
-## Database
+
+#### Environment Variables
+We use [dotenv](https://github.com/motdotla/dotenv) to keep ourselves sane with
+the various environment variables. 
+
+Copy `example.env` to `.env` and then fill in the variables. The only ones
+that are critical locally are Github variables for sign in. For everything else,
+you can setup test accounts if you'd like.
+
+#### Database Setup
 Download and install [MongoDB](https://www.mongodb.org/downloads)
 
 When you run `npm start`, mongod will be forked as a background process. No need
 to create the database either. You're all set.
 
+After you're done, make sure you run `npm stop` to shut down mongod.
+
+## Running the application
+
+Run the application with `$ npm start`.
+
 ## Development
 
 If you add any runtime dependencies, you must run `npm shrinkwrap` and
 commit changes to `npm-shrinkwrap.json`.
 
-### Building Assets
-
-To build assets locally, you'll need to install Bower dependencies and run these Gulp tasks:
 
-```bash
-$ bower install
-$ gulp sass
-$ gulp javascript
-```
-
-Remember to re-run these tasks after pulling or changing branches.
