mirrors/group-actor
1
0
Fork 0
mirror of https://git.ondrovo.com/MightyPork/group-actor.git synced 2024-11-21 23:51:01 +00:00
Code Issues Projects Releases Packages Wiki Activity

improve readme somewhat

Browse source
This commit is contained in:
Ondřej Hruška 2021-08-28 10:42:27 +02:00
parent c52147ad4d
commit 9f7de72382
No known key found for this signature in database
GPG key ID: 2C5FD5035250423D
1 changed files with 22 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -1,4 +1,5 @@
# Fedi Groups # Fedi Groups
## How it works ## How it works
This is an approximation of groups you can use right now with existing fedi software that implements the Mastodon client API. This is an approximation of groups you can use right now with existing fedi software that implements the Mastodon client API.
@ -8,6 +9,8 @@ Groups implement moderation (banning users and instances, member-only mode with
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. 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.
*Note: In this document, "reblog" and "boost" are used interchangeably.*
### Advantages of emulated groups ### Advantages of emulated groups
Unlike some other attempts at group implementation (namely gup.pe 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. Unlike some other attempts at group implementation (namely gup.pe 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.
@ -95,8 +98,25 @@ An example systemd service file is included in the repository as well. Make sure
### Sharing into the group ### Sharing into the group
The group will boost (reblog) any status meeting these criteria: The group will boost any status meeting these criteria:
- - The visiblity is public or unlisted
- It's not a command request (i.e. mentions the group user and contains valid command(s))
- Either:
- it mentions the group user and is not a reply
- or, it contains one of the group hashtags
Examples of posts that will be shared:
- `@group Look at this duck` (public or unlisted)
- `Look at this duck @group` (public or unlisted)
- `I love #ducks` (public or unlisted, if #ducks is a group hashtag)
- `@otheruser tell me about #ducks` (in a thread, public or unlisted, if #ducks is a group hashtag)
- `Ducks are cool @otheruser @group` (original post)
These won't be shared:
- `ducks suck`
- `@group /remove #ducks` (admin command, even if it includes a group hashtag)
- `@otheruser tell me about ducks` (in a thread)
- `@otheruser @group tell me about ducks` (in a thread)
### Commands ### Commands