Skip to content

Commit 492f681

Browse files
authored
1 parent 8def00c commit 492f681

File tree

1 file changed

+56
-46
lines changed

1 file changed

+56
-46
lines changed

README.md

Lines changed: 56 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -6,56 +6,78 @@ SPDX-License-Identifier: CC-BY-SA-4.0
66

77
# Draupnir
88

9-
A highly capable [Matrix](https://matrix.org) moderation bot and protection
10-
platform, trusted by room moderators and homeserver admins alike.
9+
Draupnir is a unified platform to grow, manage, and sustain communities on
10+
Matrix.
1111

12-
Visit [#draupnir:matrix.org](https://matrix.to/#/#draupnir:matrix.org) in your
13-
client and come say hi.
12+
## Why communities choose Draupnir
1413

15-
Please see the
16-
[draupnir documentation](https://the-draupnir-project.github.io/draupnir-documentation/)
17-
for installation instructions and usage guides.
14+
- Draupnir provides **Unified control** to manage your Matrix community from one
15+
place.
16+
- Draupnir has **Open governance** and
17+
[transparent project leadership](https://the-draupnir-project.github.io/draupnir-documentation/category/governance)
18+
grounded in grassroots community focus.
19+
- Draupnir is **Extensible**, dynamically reconfigure protections and plugins
20+
for your circumstances or needs.
21+
- Draupnir utilizes **Distributed moderation**: Subscribe to trusted,
22+
community-curated policy lists that keep spaces safe around the clock.
23+
24+
## Status
1825

19-
## Features
26+
We have recently passed a huge milestone: Draupnir's 2.0.0 release 🎉
2027

21-
- Draupnir's UX is centred around prompting you with questions to carry out
22-
specific moderation tasks by shadowing the actions taken by your Matrix
23-
Client.
28+
See
29+
[governance reports](https://the-draupnir-project.github.io/draupnir-documentation/category/reports)
30+
for the current project focus.
31+
32+
Draupnir is supported by [NLnet](https://nlnet.nl/project/Draupnir/) through the
33+
NGI Zero Core programme. The goals of this work are described
34+
[here](https://marewolf.me/posts/draupnir/24-nlnet-goals.html).
35+
36+
## Quick start
37+
38+
See
39+
[Setting up Draupnir](https://the-draupnir-project.github.io/draupnir-documentation/bot/setup).
40+
41+
Visit [#draupnir:matrix.org](https://matrix.to/#/#draupnir:matrix.org) in your
42+
client and come say hi.
2443

25-
- Draupnir synchonises bans for users, and servers across all of the matrix
26-
rooms that you moderate
44+
## Core Features
45+
46+
- Draupnir's UX is centred around intuitive interactive prompts, with no need to
47+
type out commands for most activities. Just use your client to invite the bot
48+
to rooms, or manage community members, and Draupnir will prompt you to
49+
complete your changes.
2750

2851
- Draupnir can protect your community by applying policies from community
2952
curated policy lists. For example lists such as the the
30-
[community moderation effort](https://matrix.to/#/#community-moderation-effort-bl:neko.dev),
53+
[community moderation effort](https://matrix.to/#/#community-moderation-effort-bl:neko.dev)
3154
can be watched to protect your rooms around the clock. This means that
3255
adjacent Matrix communities can warn and protect each other of known threats.
3356
Draupnir and the list provided by the community moderation effort are the
3457
bread and butter essentials of moderating public spaces on Matrix.
3558

59+
- Draupnir includes advanced
60+
[homeserver administrative](https:/the-draupnir-project.github.io/draupnir-documentation/bot/homeserver-administration)
61+
features, such as automatically suspending user accounts, blocking
62+
invitations, and taking down rooms. As well as reviewing abuse reports. This
63+
also includes protecting your homeserver with Draupnir's watched policy rooms.
64+
65+
- Draupnir can be used standalone to protect a community without a homeserver.
66+
3667
- Draupnir includes a series of
3768
[protections](https://the-draupnir-project.github.io/draupnir-documentation/protections)
3869
that can be enabled that can help you in given scenarios when your community
3970
is being targeted.
4071

41-
- Draupnir includes
42-
[homeserver administrative](https:/the-draupnir-project.github.io/draupnir-documentation/bot/homeserver-administration)
43-
features, such as reviewing abuse reports, deactivating user accounts and
44-
shutting down rooms. This also includes protecting your homeserver with
45-
Draupnir's watched policy rooms.
46-
47-
- Draupnir is primarily a room moderation bot and can be used with or without
48-
server administrative capabilities.
49-
5072
- **Draupnir is a forwards and backwards compatible drop in replacement for
5173
[Mjolnir](https://github.com/matrix-org/mjolnir)**.
5274

5375
### Prompt UX
5476

55-
The main difference from Mjolnir is that it is no longer necessary to use
56-
commands for some functions. Banning a user in a protected room from your Matrix
57-
client will cause Draupnir to show a prompt in the management room, which will
58-
offer to add the ban to a policy list[^the-gif-width].
77+
It is no longer necessary to use commands for most core functions. Banning a
78+
user in a protected room from your Matrix client will cause Draupnir to show a
79+
prompt in the management room, which will offer to add the ban to a policy
80+
list[^the-gif-width].
5981

6082
![A demo showing a propagation prompt](docs/ban-propagation-prompt.gif)
6183

@@ -80,13 +102,11 @@ unexpected errors much more easily.
80102

81103
> I offer you the ring, which was burned, laid upon the pyre of Baldr by Odin.
82104
83-
Draupnir started as a fork of [Mjolnir](https://github.com/matrix-org/mjolnir),
84-
in order to radically refactor the code base and break a feature freeze.
85-
Draupnir has now completed this refactor and large sections of the the code base
86-
are now very distinct, as much of Draupnir was rewritten.
105+
Draupnir began as a fork of [Mjolnir](https://github.com/matrix-org/mjolnir), in
106+
order to break a feature freeze and improve the architecture.
87107

88108
**Draupnir remains a forwards and backwards compatible drop in replacement for
89-
Mjolnir**.
109+
Mjolnir** that provides significant technical improvements:
90110

91111
- Draupnir is much less dependant on commands and will automatically send
92112
prompts to the management room. Prompts are sent for inviting Draupnir to
@@ -129,21 +149,13 @@ Mjolnir**.
129149
[typescript-eslint](https://typescript-eslint.io/) into Draupnir's development
130150
tooling, modernising TypeScript development.
131151

132-
## Status
133-
134-
Draupnir is being supported with a grant from NLnet, the goals of the work are
135-
described [here](https://marewolf.me/posts/draupnir/24-nlnet-goals.html)
136-
137-
Currently The UX and code base of Draupnir has been overhauled and we have
138-
recently passed a huge milestone: Draupnir's 2.0.0 release.
139-
140152
### Migration
141153

142154
Migrating from Mjolnir is straightforward and requires no manual steps,
143155
migration for your setup is likely as simple as changing your server config to
144-
pull the latest Draupnir docker image instead of a mjolnir one. Draupnir remains
145-
backwards compatible so that it is possible to try Draupnir and still have the
146-
option to switch back to Mjolnir.
156+
pull the latest Draupnir docker image `gnuxie/draupnir:latest` instead of a
157+
mjolnir one. Draupnir remains backwards compatible so that it is possible to try
158+
Draupnir and still have the option to switch back to Mjolnir.
147159

148160
Any problems with migration should be reported to our
149161
[support room](https://matrix.to/#/#draupnir:matrix.org).
@@ -161,8 +173,6 @@ See
161173
[homeserver administration](https://the-draupnir-project.github.io/draupnir-documentation/bot/homeserver-administration)
162174
for how to use Draupnir's features to protect your homeserver and users.
163175

164-
## Quickstart guide
165-
166176
After your bot is up and running, you'll want to run a couple commands to get
167177
everything set up:
168178

@@ -183,7 +193,7 @@ documentation for which can be found
183193

184194
## Contributing & Opening Issues
185195

186-
Draupnir wants to be yours as much as it is ours. Please see or
196+
Please see or
187197
[contributing document](https://the-draupnir-project.github.io/draupnir-documentation/contributing),
188198
but do not worry too much about following the guidance to the letter. And keep
189199
that in mind throughout.

0 commit comments

Comments
 (0)