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

added "can I use it" section to the docs

Browse source 
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.
This commit is contained in:
Olivia Lee 2024-12-01 18:15:02 -08:00
parent eda34adef2
commit c7011fb70d
No known key found for this signature in database
GPG key ID: 54D568A15B9CD1F9
1 changed files with 16 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

16
book/introduction.md
View file

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