From 5e02d154de506af7014316de86893bb1d015fa70 Mon Sep 17 00:00:00 2001
From: Luke Slater <tinmachin3@gmail.com>
Date: Sat, 10 Mar 2012 19:40:02 +0000
Subject: [PATCH] started writing documentation file

---
 README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a69235d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+# Depressionbot IRC Bot
+
+## Introduction
+
+Depressionbot is an IRC bot which aims to be the fanciest IRC bot around - On
+the general standard of software fanciness, dbot is rated as being '75% the same
+as bathing in fine, fine grape juice.'
+
+Requirements: 
+    - Node JS
+    - JSbot, the Javascript library I wrote to handle the IRC protocol and event
+      listeners etc.
+    - Various modules have their own requirements also.
+
+## Modules:
+
+### Quotes
+
+### Admin
+
+Various administration functionality such as banning users, hot-reloading the 
+code and ordering him to talk. Note that commands added here are handled with
+their own listener, rather than being part of the command logic which is handled
+by the Command module.
+
+### JS - Run Javascript code
+
+This module provides two commands which allow the execution of Javascript code.
+For regular users, there is the *~js* command, which is completely sandboxed,
+but can still be used for calculation and the like.
+
+Example:
+    > ~js Array(16).join('wat'-1) + " Batman!";
+    'NaNNaNNaNNaNNaNNaNNaNNaNNaNNaNNaNNaNNaNNaNNaN Batman!'
+
+This feature is fairly safe as the user doesn't have access to anything
+dangerous, and is safe from infinite loops or locking DBot up because the code
+which is run is killed if it does not finish within a short amount of time.
+
+For administrators, the incredibly useful *~ajs* command is also available. The
+input for this command is simply 'eval'-ed and therefore has full access to
+DBot's memory. Of course, this is incredibly unsafe, but I find it rather fun.
+It's useful for administrative activity for which there isn't an in-built
+command. For example, you could hot-add a new administrator like this:
+
+    > ~ajs dbot.admin.push('batman');
+    2
+
+You can also use this for debugging, or even adding new commands while DBot is
+running.