From 13b4650e845e31185c0a1cdadc2e7009ef3a9e0a Mon Sep 17 00:00:00 2001
From: Erik Arvstedt <erik.arvstedt@gmail.com>
Date: Sun, 15 Aug 2021 11:28:43 +0200
Subject: [PATCH] versioning: add usage comment

---
 modules/versioning.nix | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/modules/versioning.nix b/modules/versioning.nix
index 445edf8..6b0121e 100644
--- a/modules/versioning.nix
+++ b/modules/versioning.nix
@@ -1,5 +1,10 @@
 { config, pkgs, lib, ... }:
 
+# Workflow for releasing a new nix-bitcoin version with incompatible changes:
+# Let V be the version of the upcoming, incompatible release.
+# 1. Add change descriptions with `version = V` at the end of the `changes` list below.
+# 2. Set `nix-bitcoin.configVersion = V` in ../examples/configuration.nix.
+
 with lib;
 let
   version = config.nix-bitcoin.configVersion;