From 09f6ad1d0c188b5f736ae0f32884b902ea8a41c2 Mon Sep 17 00:00:00 2001
From: Bryan Ashby <bryan@l33t.codes>
Date: Thu, 19 Nov 2015 22:34:55 -0700
Subject: [PATCH] * Updated quickstart just slightly * Start work on config.md
 configuration notes

---
 docs/config.md | 22 ++++++++++++++++++++++
 docs/index.md  |  5 ++++-
 2 files changed, 26 insertions(+), 1 deletion(-)
 create mode 100644 docs/config.md

diff --git a/docs/config.md b/docs/config.md
new file mode 100644
index 00000000..3039b05f
--- /dev/null
+++ b/docs/config.md
@@ -0,0 +1,22 @@
+## Configuration
+Configuration files in ENiGMA½ are simple UTF-8 encoded [HJSON](http://hjson.org/) files. HJSON is just like JSON but simplified and much more resilient to human error.
+
+### System Configuraiton
+The main system configuration file, `config.hjson` both overrides defaults and provides additional configuration such as message areas. This file shoudl be created in `~/.config/enigma-bbs/config.hjson`. Values found in core/config.js may be overridden by simply providing the object members you wish replace.
+
+#### Example: System Name
+`core/config.js` provides the default system name as follows:
+```javascript
+general : {
+  boardName : 'Another Fine ENiGMA½ System'
+}
+```
+
+To override this for your own board, in `config.hjson`:
+```hjson
+general: {
+  boardName: Super Fancy BBS
+}
+```
+
+TODO: document Windows ~/... path example
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
index f8b7e141..57ede2ab 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -44,4 +44,7 @@ messages: {
 ./main.js
 ```
 
-The first user you create via applying is the root SysOp.
\ No newline at end of file
+Some points of interest:
+* Default ports are 8888 (Telnet) and 8889 (SSH)
+* The first user you create via applying is the root SysOp.
+* 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