From 776ca45c983239cdc8df862c13109f4d30307568 Mon Sep 17 00:00:00 2001 From: marshmallow Date: Fri, 7 Nov 2025 12:03:54 +1100 Subject: [PATCH] update installation details --- doc/guides/installation.md | 15 ++++++++++++--- doc/snippets/guides/installation/flake.lock | 4 ++-- doc/snippets/guides/installation/flake.nix | 2 +- doc/snippets/guides/installation/hive.nix | 10 ++++++++++ 4 files changed, 25 insertions(+), 6 deletions(-) create mode 100644 doc/snippets/guides/installation/hive.nix diff --git a/doc/guides/installation.md b/doc/guides/installation.md index 2e0fc8d..7f7da68 100644 --- a/doc/guides/installation.md +++ b/doc/guides/installation.md @@ -8,7 +8,12 @@ description: How to install wire tool. {{ $frontmatter.description }} -It is recommended you stick to versioned tags, the latest is `0.5.0`. +::: info + +The `wire` binary and the `wire.makeHive` function are tightly coupled, so it is +recommended that you use the same version for both. + +::: ## Binary Cache @@ -25,7 +30,7 @@ either editing `/etc/nix/nix.conf` or updating your NixOS configuration: ## Installation through flakes When using flakes, you should install wire through the same input you create -your hive from. +your hive from, sourced from the `stable` branch. ::: code-group <<< @/snippets/guides/installation/flake.nix{38} [flake.nix] @@ -33,10 +38,14 @@ your hive from. ## Installation through npins +With npins you may allow it to use release tags instead of the `stable` +branch. + ```sh -$ npins add github mrshmllow wire --at v0.5.0 +$ npins add github mrshmllow wire ``` ::: code-group <<< @/snippets/guides/installation/shell.nix{8} [shell.nix] +<<< @/snippets/guides/installation/hive.nix{8} [hive.nix] ::: diff --git a/doc/snippets/guides/installation/flake.lock b/doc/snippets/guides/installation/flake.lock index 26c9737..596e219 100644 --- a/doc/snippets/guides/installation/flake.lock +++ b/doc/snippets/guides/installation/flake.lock @@ -326,13 +326,13 @@ "locked": { "lastModified": 1758104393, "narHash": "sha256-ddXhp8hDFMKUiVf+V5Q71Ehfw8o1kGofxN9cAljyfOI=", - "owner": "wires-org", + "owner": "mrshmllow", "repo": "wire", "rev": "6c99f40273aa16dc6603375dc2c867b9265a289a", "type": "github" }, "original": { - "owner": "wires-org", + "owner": "mrshmllow", "ref": "v0.5.0", "repo": "wire", "type": "github" diff --git a/doc/snippets/guides/installation/flake.nix b/doc/snippets/guides/installation/flake.nix index a8b3ade..aa1712b 100644 --- a/doc/snippets/guides/installation/flake.nix +++ b/doc/snippets/guides/installation/flake.nix @@ -1,7 +1,7 @@ { inputs = { nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable"; - wire.url = "github:mrshmllow/wire/v0.5.0"; + wire.url = "github:mrshmllow/wire/stable"; systems.url = "github:nix-systems/default"; }; diff --git a/doc/snippets/guides/installation/hive.nix b/doc/snippets/guides/installation/hive.nix new file mode 100644 index 0000000..b484819 --- /dev/null +++ b/doc/snippets/guides/installation/hive.nix @@ -0,0 +1,10 @@ +let + sources = import ./npins; + wire = import sources.wire; +in + wire.makeHive { + # give wire nixpkgs from npins + meta.nixpkgs = import sources.nixpkgs {}; + + # ... + } -- 2.51.2