From 2f639fc86e62e9c43240bf7bee23d940cbcfe813 Mon Sep 17 00:00:00 2001 From: Stefano Pigozzi Date: Wed, 4 Dec 2019 17:35:07 +0100 Subject: [PATCH] [5.1.3] --- README.md | 36 ++++++++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 151cf67b..55268ea5 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,46 @@ A multipurpose bot framework and webserver `royalnet` is a Python framework that allows you to create interconnected modular chat bots accessible through multiple interfaces (such as Telegram or Discord), and also modular websites that can be connected with the bots. -### Supported bot platforms +### Supported bot platforms ("serfs") - [Telegram](https://core.telegram.org/bots) - [Discord](https://discordapp.com/developers/docs/) ## Installing -Installing `royalnet` is a bit messy right now; please wait for the release of `5.1`! +To install all `royalnet` modules, run: + +``` +royalnet[telegram,discord,alchemy_easy,bard,constellation,sentry,herald,coloredlogs] +``` + +> You will soon be able to install only the modules you need instead of the full package, but the feature isn't ready yet... + +## Developing `royalnet` + +To develop `royalnet`, you need to have [Poetry](https://poetry.eustace.io/) installed on your PC. + +After you've installed Poetry, clone the git repo with the command: + +``` +git clone https://github.com/Steffo99/royalnet +``` + +Then enter the new directory: + +``` +cd royalnet +``` + +And finally install all dependencies and the package: + +``` +poetry install -E telegram -E discord -E alchemy_easy -E bard -E constellation -E sentry -E herald -E coloredlogs +``` + +## Developing `royalnet` packages + +> TODO ## Documentation