Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesread committed Dec 5, 2023
1 parent 6e086b5 commit 24706db
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
````

0 comments on commit 24706db

Please sign in to comment.