summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d8263fb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+## What is JabberHive?
+JabberHive is a modular Reply Bot system. All "modules" are in fact separate
+programs linked together using the JabberHive Protocol. Please refer to the
+protocol for more information.
+
+## Component Description
+* Server for a JabberHive network.
+* Handles learning & replying using K-order Markov Chains, with k >= 2.
+* Knowledge is kept in RAM.
+
+## JabberHive Protocol Compatibility
+* **Protocol Version(s):** 1 (Targeted).
+* **Inbound Connections:** Multiple.
+* **Outbound Connections:** None.
+* **Pipelining:** No.
+* **Behavior:** Server.
+
+## Dependencies
+- POSIX compliant OS.
+- C compiler (with C99 support).
+- CMake.