Add installation instructions

[syncthing-autoregister] / README

diff --git a/README b/README
index d462866dbfe67e31e2f79fa91d414b69a967d833..64b59d051c2b9fad9d98f260b5e77e6bd1330a2c 100644 (file)
--- 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.
 
 
 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
 
     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
 
 
     $ 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.
 
     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