From 24706db6def2815fcb68986ab24e5099fe588925 Mon Sep 17 00:00:00 2001 From: jamesread Date: Tue, 5 Dec 2023 22:52:28 +0000 Subject: [PATCH] Readme update --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index dbb5c25..2046215 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,14 @@ -Japella -=== +# japella + An extensible chatbot application, built with containers connected to a message queue. Japella's architecture splits out the connections to different protocols (eg Telegram, Discord) into "adaptor" services, and all bot functionality is implemented in a separate service, meaning that the chatbot functionality can easily work with new protocols, by just creating a new adaptor, or, can relay chat messages across protocols, for example. -=== Quickstart +## Quickstart -Japella is only distributed as a x86_64 Linux container. +Japella is only distributed as a x86_64 Linux container, and requires a RabbitMQ server as the message queue. ```` +user@host: docker create docker.io/rabbitmq -P 5672:5672 --name rabbitmq user@host: docker create ghcr.io/jamesread/japella-adaptor-telegram --name japella-telegram ````