From cdfd0740244b72fd6b18a96d17a914ccffbf411d Mon Sep 17 00:00:00 2001
From: Bryan Ashby <NuSkooler@gmail.com>
Date: Tue, 8 Dec 2015 11:21:21 -0700
Subject: [PATCH] Updated quickstart to note Node version requirements/etc. and
 better overall docs

---
 docs/index.md | 27 ++++++++++++++-------------
 1 file changed, 14 insertions(+), 13 deletions(-)

diff --git a/docs/index.md b/docs/index.md
index 7152cf1a..39767ba6 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -4,29 +4,29 @@ ENiGMA½ is a modern from scratch BBS package written in Node.js.
 # Quickstart
 TL;DR? This should get you started...
 
-1\. Clone
+## Prerequisites
+* Node.js version **v0.12.2 or higher** (v4.2+ is recommended). io.js should also work, though I have not yet tested this.
+* Windows users will need additional dependencies installed for the `npm install` step in order to compile native binaries:
+  * A recent copy of Visual Studio (Express editions OK)
+  * Python 2.7.x
+  
+## Clone
 ```bash
 git clone https://github.com/NuSkooler/enigma-bbs.git
 ```
 
-2\. Install dependencies
+## Install Node Modules
 ```bash
 npm install
 ```
 
-**Note for Windows users**:<br>
-Some dependencies require compilation. You will need at least the following installed for `npm install` to succeed:
-* A recent copy of Visual Studio (Express editions OK)
-* Python 2.7.x
-
-3\. Generate a SSH Private Key<br>
-Note that you can skip this step and disable the SSH server in your `config.hjson` if desired.
-
+## Generate a SSH Private Key
+To utilize the SSH server, a SSH Private Key will need generated. This step can be skipped if desired by disabling the SSH server in `config.hjson`.
 ```bash
 openssl genrsa -des3 -out ./misc/ssh_private_key.pem 2048
 ```
 
-4\. Create a minimal config<br>
+## Create a Minimal Config
 The main system configuration is handled via `~/.config/enigma-bbs/config.hjson`. This is a [HJSON](http://hjson.org/) file (compiliant JSON is also OK). See [Configuration](config.md) for more information.
 
 ```hjson
@@ -36,6 +36,7 @@ general: {
 servers: {
   ssh: {
     privateKeyPass: YOUR_PK_PASS
+  }
 }
 messages: {
   areas: [
@@ -44,12 +45,12 @@ messages: {
 }
 ```
 
-5\. Launch!
+## Launch!
 ```bash
 ./main.js
 ```
 
 Some points of interest:
 * Default ports are 8888 (Telnet) and 8889 (SSH)
-* The first user you create via applying is the root SysOp.
+* The first user you create via applying is the SysOp (aka root)
 * You may want to tail the logfile with Bunyan: `tail -F ./logs/enigma-bbs.log | ./node_modules/bunyan/bin/bunyan`
\ No newline at end of file