backups/grapevine
1
0
Fork 0
mirror of https://gitlab.computer.surgery/matrix/grapevine.git synced 2025-12-16 15:21:24 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

rewrite "Can I use it?" section

Browse source
This commit is contained in:
Charles Hall 2024-12-11 20:10:04 -08:00
parent 1808ad66f4
commit 5c4d7bbe37
No known key found for this signature in database
GPG key ID: 7B8E0645816E07CF
1 changed files with 9 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

15
book/introduction.md
View file

@ -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