diff --git a/README.md b/README.md index 489b960..ea65a92 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ # piped-federation All information about Piped's federation protocol on Matrix. + +## How to join? + +Register on a homeserver with no rate-limiting, or create your own homeserver. + +If you would like an account on the `federation.piped.video` homeserver, message [@kavin1337:matrix.org](https://matrix.to/#/@kavin1337:matrix.org) on Matrix. + +Set the homeserver URL in `config.properties` with the `MATRIX_SERVER` property. +Example: `MATRIX_SERVER:https://matrix-client.matrix.org` + +Set the Matrix access token with the `MATRIX_TOKEN` property. + +Restart your Piped backend. + +Send a PR to add your account to the [authorized-users.json](/authorized-users.json) file. + +## Recommended homeservers to Host + +Conduit: https://conduit.rs/