1 files changed, 29 insertions, 1 deletions
diff --git a/README.MD b/README.MD
index 8a6aaa5..9c93f45 100644
--- a/README.MD
+++ b/README.MD
@@ -2,6 +2,7 @@
---
A project to make invite spam more manageable at scale.
+[Matrix room](https://matrix.to/#/%23anti-dm-spam%3Arory.gay?via=rory.gay)
## Dependencies
- `dotnet-sdk 9.0.200+`
@@ -16,5 +17,32 @@ git clone --recursive https://cgit.rory.gay/matrix/tools/MatrixAntiDmSpam.git
cd MatrixAntiDmSpam/MatrixAntiDmSpam
# Build the project
-dotnet publish -c Release
+dotnet publish -c Release
+
+# Install binaries
+sudo cp bin/net9.0/Release/publish /opt/MatrixAntiDmSpam
+```
+
+Next, you want to set up a working directory (`~/.local/share/MatrixAntiDmSpam` works well), and copy your access token into a new file (ie. `nano -L ~/.matrix-access-token`).
+
+Additionally, you want to copy `appsettings.Development.json` into your working directory, edit it to your liking and rename it to `appsettings.json`.
+
+<details>
+ <summary>Advanced configuration</summary>
+
+ Additionally: you can use `appsettings.SomethingHere.json` and use `DOTNET_ENVIRONMENT=SomethingHere` if you want to set this up for multiple accounts. `appsettings.json` is always loaded for shared values.
+
+ Alternatively, you can use environment variables like `LibMatrixBot__AccessTokenPath=/path/to/access-token` to override values in the configuration file, using double undercores (`__`) as path separator.
+</details>
+
+Note that `PolicyLists` refers to special rooms known as Policy List rooms, which are commonly used by moderation bots as Mjolnir and Draupnir.
+Additionally, Element Web supports these for hiding messages via a labs flag.
+
+Also note that these may break certain clients, such as FluffyChat ([#814](https://github.com/krille-chan/fluffychat/issues/814), [#858](https://github.com/krille-chan/fluffychat/issues/858), [#905](https://github.com/krille-chan/fluffychat/issues/905)).
+
+## Running
+```shell
+# Run the bot
+cd ~/.local/share/MatrixAntiDmSpam
+/opt/MatrixAntiDmSpam/MatrixAntiDmSpam
```
\ No newline at end of file
|
