From 1e96b266a195338cb1721aa76313cce6a1b96950 Mon Sep 17 00:00:00 2001 From: Nathanael Sensfelder Date: Sat, 22 Apr 2017 17:55:59 +0200 Subject: Initial Commit. --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..0da4380 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +## 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 +* CLI Gateway for a JabberHive network. +* Allows the use of the Command Line Interface to send requests using stdin. +* All replies are displayed in stdout. +* Handles the lack of pipelining by not reading from stdin if it's not ready to +send. + +## JabberHive Protocol Compatibility +* **Protocol Version(s):** 1. +* **Inbound Connections:** None. +* **Outbound Connections:** Single. +* **Pipelining:** No. +* **Behavior:** Gateway. + +## Dependencies +- POSIX compliant OS. +- C compiler (with C99 support). +- CMake. -- cgit v1.2.3-70-g09d2