improve readme

Ondřej Hruška 3 years ago
parent d2ccdba26e
commit 54dd2a0b40
  1. 22

@ -1,5 +1,18 @@
# Groups for Pleroma!!!
and Mastodon or anything with the Mastodon API.
# Fedi Groups
## How it works
This is an approximation of groups you can use right now with existing fedi software that implements the Mastodon client API.
A group is a regular user account controlled by a "bot" service that runs on a Linux server (e.g. a Rpi in your closet). To join a group, simply follow the group user. To post into the group, tag the group user in a top-level post (not a reply), or use `/b` in a reply to share the parent post to the group. The group will reblog shared posts to its members.
Groups implement moderation (banning users and instances, member-only mode with user whitelist). This is controlled by slash commands, see below.
Group admins can issue group announcements that are posted poublicly by the group user, such as when there is a planned maintenance. The group will attempt to catch up with posts missed during the outage.
### Advantages of emulated groups
Unlike some other attempts at group implementation (namely or the mythical WIP Pleroma Groups), this works with current Pleroma and Mastodon. There's no need for interoperability in different server implementations, since it uses existing follow/mention/reblog features that are already cross-compatible. Mastodon users can join a group running on Pleroma and vice-versa.
Groups probably can't be hosted on Honk and Misskey, but their users can use groups hosted elsewhere just fine.
## Usage
@ -71,12 +84,11 @@ Note that the file must be writable, it is updated at run-time.
### Commands
To share an original post, mention the group user.
Posts with commands, and replies, won’t be shared.
Commands are simple text lines you use when mentioning the group user. DMs work well for this.
One post can contain multiple commands; the replies will be batched to one response.
Posts with commands won’t be boosted by the group actor.
**Basic commands**
- `/ignore, /i` - make the group completely ignore the post
- `/members, /who` - show group members / admins