update some documentation a bit for new users

Signed-off-by: strawberry <strawberry@puppygock.gay>
This commit is contained in:
strawberry 2024-04-25 20:21:48 -04:00 committed by June
parent 5195593f55
commit 6fd3123660
7 changed files with 64 additions and 65 deletions

View file

@ -1,10 +1,10 @@
# Conduwuit for NixOS
# conduwuit for NixOS
Conduwuit can be acquired by Nix from various places:
conduwuit can be acquired by Nix from various places:
* The `flake.nix` at the root of the repo
* The `default.nix` at the root of the repo
* From Conduwuit's binary cache
* From conduwuit's binary cache
A binary cache for conduwuit that the CI/CD publishes to is available at the
following places (both are the same just different names):
@ -20,7 +20,7 @@ If specifying a URL in your flake, please use the GitHub remote: `github:girlbos
The `flake.nix` and `default.nix` do not (currently) provide a NixOS module, so
(for now) [`services.matrix-conduit`][module] from Nixpkgs should be used to
configure Conduit.
configure conduwuit.
If you want to run the latest code, you should get Conduwuit from the `flake.nix`
or `default.nix` and set [`services.matrix-conduit.package`][package]