From c7011fb70d9c2d1611655b98ac701a90cf9de5d3 Mon Sep 17 00:00:00 2001 From: Olivia Lee Date: Sun, 1 Dec 2024 18:15:02 -0800 Subject: [PATCH] added "can I use it" section to the docs This was based on the similar section in the hedgedoc. I dropped the bit about grapevine users getting banned from the conduwuit rooms cause we haven't heard about that happening for a while and the original case was pretty unclear. --- book/introduction.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/book/introduction.md b/book/introduction.md index 3f183042..055ee6b8 100644 --- a/book/introduction.md +++ b/book/introduction.md @@ -73,6 +73,22 @@ best. Additionally, due to our goals, the development of new features may be slower than alternatives. We find this to be an acceptable tradeoff considering the importance of the reliability of a project like this. +## Can I use it? + +Theoretically yes, but it's not in a good state for general users yet. There +[isn't very much user-facing docs yet][docs-issue], we +[don't have releases yet][releases-issue], we don't currently publish any binary +builds, and there are several breaking changes to the conduit config that +haven't been documented in detail yet. If building from source and figuring out +the config by reading source code/commit messages doesn't scare you away, go +for it! + +If you use nixos, [here's an example][nixos-example]. + +[docs-issue]: https://gitlab.computer.surgery/matrix/grapevine/-/issues/21 +[releases-issue]: https://gitlab.computer.surgery/matrix/grapevine/-/issues/18 +[nixos-example]: https://gitlab.computer.surgery/charles/servy-fleet/-/blob/main/config/grapevine/default.nix + --- [^1]: A "maintainer" is someone who has the ability to close issues opened by