Initial commit.

1 files changed, 24 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b4d5d39
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+## What is JabberHive?
+JabberHive is a modular ChatBot system. All "modules" are in fact separate
+programs linked together using the JabberHive Protocol. Please refer to the
+protocol for more information.
+
+## Component Description
+* Filter for a JabberHive network.
+* Randomly transforms ?RLR queries into ?RL ones.
+* The transformation chance is a run-time parameter.
+
+## JabberHive Protocol Compatibility
+* **Protocol Version(s):** 1.
+* **Inbound Connections:** Multiple.
+* **Outbound Connections:** Multiple.
+* **Pipelining:** No.
+* **Behavior:** Gateway.
+
+## Notes
+* Does not correctly reply to Pipelining & Protocol Version requests.
+
+## Dependencies
+- POSIX compliant OS.
+- C compiler (with C99 support).
+- CMake.