ryg/royalnet
ryg/royalnet
1
Fork 0
mirror of https://github.com/RYGhub/royalnet.git synced 2024-11-23 19:44:20 +00:00
Code Activity

Improve README again

Browse source
This commit is contained in:
Steffo 2020-06-15 01:45:54 +02:00
parent 900cd49474
commit 3f666c40b3
Signed by: steffo
GPG key ID: 896A80F55F7C97F0
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -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)