Add NixOS config example

1 files changed, 13 insertions, 0 deletions

diff --git a/examples/nixos/README.md b/examples/nixos/README.md
new file mode 100644
index 0000000..ea6b9f4
--- /dev/null
+++ b/examples/nixos/README.md
@@ -0,0 +1,13 @@
+# NixOS example
+
+This example shows how to install `temp-postgres` on NixOS using Nix flakes.
+
+You can actually run this configuration as a virtual machine on QEMU:
+
+```sh
+# Use the latest version of temp-postgres.
+nix run ".#nixosConfigurations.myhost.config.system.build.vm"
+
+# Use the worktree version of temp-postgres.
+nix run --override-input temp-postgres ../.. ".#nixosConfigurations.myhost.config.system.build.vm"
+```