From 3f666c40b3013ad2e65f4cce2102bf3882091ab1 Mon Sep 17 00:00:00 2001 From: Stefano Pigozzi Date: Mon, 15 Jun 2020 01:45:54 +0200 Subject: [PATCH] Improve README again --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index d18848e6..c8161807 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,18 @@ The Constellation service is a [Starlette](https://www.starlette.io )-based webs The Constellation service also offers utilities for creating REST APIs as Python functions with `dict`s as inputs and outputs, leaving (de)serialization, transmission and eventually authentication to Royalnet. +### Sentry + +Royalnet can automatically report uncaught errors in all services to a [Sentry](https://sentry.io )-compatible server, while logging them in the console in development environments to facilitate debugging. + +### Packs + +New Serf _commands_, Constellation _stars_, Herald _events_ and Alchemy _tables_ can be added to Royalnet through plugins called "Packs" that can be activated or deactivated on each single instance. + +#### Config + +Each pack can access only its individual section in the configuration file, preventing key conflicts (as long as the packs themselves don't share the same name). + ## Installing Royalnet To install `royalnet`, run: @@ -90,3 +102,7 @@ And finally install all dependencies and the package: ``` poetry install -E telegram -E discord -E matrix -E alchemy_easy -E bard -E constellation -E sentry -E herald -E coloredlogs ``` + +## Help! + +Need help in anything Royalnet-related? [Open a issue on GitHub!](https://github.com/Steffo99/royalnet/issues/new) \ No newline at end of file