From 5c4d7bbe372d5978c0791e24a6aac6fe8ea15261 Mon Sep 17 00:00:00 2001 From: Charles Hall Date: Wed, 11 Dec 2024 20:10:04 -0800 Subject: [PATCH] rewrite "Can I use it?" section --- book/introduction.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/book/introduction.md b/book/introduction.md index 4f02e389..df2fbddf 100644 --- a/book/introduction.md +++ b/book/introduction.md @@ -90,13 +90,16 @@ 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], and there are several breaking changes to the conduit -config that haven't been documented in detail yet. If these issues don't scare -you away, go for it! +Theoretically yes, but it's not ready for general use yet, because: -If you use nixos, [here's an example][nixos-example]. +* [There aren't any releases][releases-issue]. +* [There isn't very much user-facing documentation][docs-issue]. +* There have been several additions and breaking changes to the configuration + file format that haven't been documented in detail. This means you'll need to + read the source code to figure out what all the options are and what they do. + +If these issues don't scare you away, go for it! (And 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