From bc81af72f671aed86ae1fbfb6fa710060aa42dcd Mon Sep 17 00:00:00 2001 From: Paul Makles Date: Tue, 31 May 2022 15:00:45 +0100 Subject: [PATCH] chore: update README --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 07205ab..36789f4 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ +# Before you get started + This is still a work-in-progress and some things may not work but for the most part everything has been tested without issue! **Note**: the Revolt team is primarily focused on other components of the app, don't expect any immediate support, some issues may also be seen as out of scope for what this repo is trying to achieve so they may be marked as WONTFIX. +Please [read the FAQ before running your own server](https://developers.revolt.chat/faq/usage#guidelines-for-third-party-instances) and you may want to read about [additional notes relating to third-party instances](https://developers.revolt.chat/faq/instances). + ## Errata Notice The CI for the API server (revoltchat/server) is currently being reworked, I was having a few issues with building both amd64/arm64.