From edef05d123e7d835cce66b36116eaee29bb5e563 Mon Sep 17 00:00:00 2001
From: Adrian Malacoda <adrian.malacoda@monarch-pass.net>
Date: Mon, 13 Feb 2017 00:27:02 -0600
Subject: [PATCH] actually write somewhat of a readme

---
 README.md | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index a07af43..f7a24fe 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,13 @@
 # tenquestionmarks chat bot
 tenquestionmarks is an extensible, scriptable chat bot. This iteration is written in rust.
 
-## Architecture
-tenquestionmarks has two basic 
+## Configuration
+Configuration is done in TOML. By default, tenquestionmarks looks for `tenquestionmarks.toml`.
+
+## Modules
+tenquestionmarks is a series of modules. Modules produce events and consume events.
+
+In this particular iteration of tenquestionmarks, there are at most two threads spawned for a module: an event consumer thread and an event producer thread. However, most modules will either produce or consume, not both.
+
+## Events
+Events are things such as message, join, quit.