From 26ed936019f90547f2193e66b370faee411cb795 Mon Sep 17 00:00:00 2001 From: kaniini Date: Sun, 18 Nov 2018 14:43:28 +0000 Subject: [PATCH] README: document how to follow other relays --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 492df0b..90bc89b 100644 --- a/README.md +++ b/README.md @@ -56,3 +56,16 @@ Performance is very good, with all data being stored in memory and serialized to JSON-LD object graph. Worker coroutines are spawned in the background to distribute the messages in a scatter-gather pattern. Performance is comparable to, if not superior to, the Mastodon relay software, with improved memory efficiency. + + +## Management + +You can perform a few management tasks such as peering or depeering other relays by +invoking the `relay.manage` module. + +This will show the available management tasks: + + $ python3 -m relay.manage + +When following remote relays, you should use the `/actor` endpoint as you would in +Pleroma and other LitePub-compliant software.