From d209177ecdc002bc62f0844ffad4853d776436da Mon Sep 17 00:00:00 2001 From: Scott Worley Date: Tue, 21 Jul 2020 12:01:26 -0700 Subject: [PATCH 1/1] Add installation instructions --- README | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README b/README index d462866..64b59d0 100644 --- a/README +++ b/README @@ -2,6 +2,8 @@ Modify in-place a nix module that configures syncthing device ids. This file can used as a normal `include` in nixos configs. This eliminates the need to copy-paste these device IDs around. +### Example + desktop$ syncthing-set-id syncthing-devices.nix Creating /home/user/myNixOSConfigs/syncthing-devices.nix @@ -45,7 +47,8 @@ Then, later, on another machine: }; } -Usage + +### Usage $ syncthing-set-id @@ -56,3 +59,23 @@ Usage If `name` is not specified, $HOSTNAME is used. If `id` is not specified, the ID of the current system instance is used. + + +### Installation + +You can use this repo as a channel. + +Or, you can use an overlay. For example, you could create a `~/.config/nixpkgs/overlays/syncthing-set-id.nix` with this in it: + + self: super: + let + syncthing-set-id-pkgs = import (builtins.fetchGit { + url = "https://scottworley.com/syncthing-set-id.git"; + ref = "master"; + rev = "0c29f01e83fdadd491b930a9108519be03c7937d"; + }) { pkgs = self; }; + in { inherit (syncthing-set-id-pkgs) syncthing-set-id; } + +And then + + $ nix-env -iA nixos.syncthing-set-id -- 2.44.1