streamline dev flow

3 files changed, 23 insertions, 8 deletions

diff --git a/documentation/DEPLOY.md b/documentation/DEPLOY.md
new file mode 100644
index 0000000..344165c
--- /dev/null
+++ b/documentation/DEPLOY.md
@@ -0,0 +1,14 @@
+# Live Deployment Installation
+
+1. [Clone](https://help.github.com/articles/cloning-a-repository/) the repository: `git clone https://github.com/hack-chat/main.git`
+1. Change the directory: `cd main/server`
+1. Install server dependencies: `npm install`
+1. Configure the server: `npm run config` (you may also migrate a `config` directory into `./main/server` if you previously configured the server elsewhere)
+1. Migrate the contents of `./main/client` into any suitable directory of your webserver
+1. (OPTIONAL) Cleanup; you may delete `main/clientSource` and `main/documentation`
+
+    You can now run start the server software with a process manager like [PM2](https://github.com/Unitech/pm2) (e.g., `pm2 start server/main.js --name HackChat`). If you plan on using SSL to serve the client; you will need to use a reverse proxy, as TLS is not natively supported by the hack.chat server software (this may change in future releases).
+
+# Advanced
+
+(TODO)
diff --git a/DOCUMENTATION.md b/documentation/DOCUMENTATION.md
index 4fa9055..b070dfa 100644
--- a/DOCUMENTATION.md
+++ b/documentation/DOCUMENTATION.md
@@ -1,19 +1,19 @@
-You can programmatically access hack.chat using the following commands via a websocket. To prevent getting disconnected, ping the server every 50 seconds. A list of wrappers written for accessing hack.chat can be found [here](https://github.com/hack-chat/3rd-party-software-list#libraries).
+You can programmatically access hack.chat using the following commands via a websocket. A list of wrappers written for accessing hack.chat can be found [here](https://github.com/hack-chat/3rd-party-software-list#libraries).
 
-The commands are to be sent through a websocket to the URL `wss://hack.chat/chat-ws` (everything sent and received are `string`s). If you are sending messages locally or to another domain, replace 'hack.chat' with the respective domain. If you're running your own instance of hack.chat, you can retain backwards-compatibility in order to ensure that software created for the main server will work on yours too.
+The commands are to be sent through a websocket to the URL `wss://hack.chat/chat-ws` (everything sent and received are JSON). If you are sending messages locally or to another domain, replace 'hack.chat' with the respective domain. If you're running your own instance of hack.chat, you can retain backwards-compatibility in order to ensure that software created for the main server will work on yours too.
 
 All commands sent must be JSON objects with the command specified in the `"cmd"` key. For example:
 ```json
 {
     "cmd": "join",
     "channel": "programming",
-    "nick": "johndoe#fag"
+    "nick": "john#doe"
 }
 ```
 
-hack.chat has three permission levels. When you access a command, hack.chat automatically knows your permission level from your trip code. The lowest permission level is `core`. `mod` is above `core`, so it can access `core` commands in addition to `mod` commands. `admin` is similarly above `mod`.
+hack.chat has three permission levels. When you access a command, hack.chat automatically knows your permission level from your trip code. The lowest permission level is `user`. `mod` is above `user`, so it can access `user` commands in addition to `mod` commands. `admin` is similarly above `mod`.
 
-# `core`
+# `user`
 
 |Command|Parameters|Explanation|
 |-------|----------|-----------|
@@ -43,4 +43,4 @@ hack.chat has three permission levels. When you access a command, hack.chat auto
 |`listusers`||Outputs all current channels and sockets in those channels.|
 |`reload`||(Re)loads any new commands into memory and outputs errors, if any.|
 |`saveconfig`||Saves the current config.|
-|`shout`|`text`|Displays the passed text to each client connected.|
\ No newline at end of file
+|`shout`|`text`|Displays the passed text to each client connected.|
diff --git a/templateCommand.js b/documentation/templateCommand.js
index 90b9aa3..1a4f3d2 100644
--- a/templateCommand.js
+++ b/documentation/templateCommand.js
@@ -1,5 +1,6 @@
 /*
-  Description: This is a template module that should not be on prod
+  Description: This is a template module that should not be user in a production
+               enviroment
 */
 
 // you can require() modules here
@@ -48,4 +49,4 @@ exports.info = {
   aliases: ['templateModule'], // optional, an array of other names this module can be executed by
   usage: 'showcase {echo}', // used for help output, can be ommited if no parameters are required
   description: 'Simple command module template & info' // used for help output
-};
\ No newline at end of file
+};