From 47bbbcd3c47c114b5b12f544f4bc1e347dfac0e3 Mon Sep 17 00:00:00 2001
From: Nico Jensch <root@dr460nf1r3.org>
Date: Wed, 27 Sep 2023 09:07:33 +0200
Subject: [PATCH] docs: add NixOS installation

---
 docs/installation.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/docs/installation.md b/docs/installation.md
index 9bd4ec0..3a48e38 100644
--- a/docs/installation.md
+++ b/docs/installation.md
@@ -162,4 +162,41 @@ cd websurfx
 git checkout stable
 ```
 
+## NixOS
+
+A flake.nix has been provided to allow installing `Websurfx` easily. It utilizes [nearsk](https://github.com/nix-community/naersk) to automatically generate a derivation based on `Cargo.toml` and `Cargo.lock`.
+
+The flake has several outputs, which may be consumed:
+
+~~~bash
+nix build .#websurfx
+nix run .#websurfx
+~~~
+
+You may include it in your own flake by adding this repo to its inputs and adding it to `environment.systemPackages`
+
+~~~nix
+{
+  description = "My configuration";
+
+  inputs = {
+    websurfx.url = "github:neon-mmd/websurfx";
+  };
+
+  outputs = { nixpkgs, ... }@inputs: {
+    nixosConfigurations = {
+      hostname = nixpkgs.lib.nixosSystem {
+        system = "x86_64-linux";
+        modules = [{
+			environment.systemPackages = [
+				inputs.websurfx.websurfx
+			];
+		}];
+      };
+    };
+  };
+}
+
+~~~
+
 [⬅️ Go back to Home](./README.md)