From b05370e2c62a9b77d46dc12aacba3de2240fa12a Mon Sep 17 00:00:00 2001
From: Aram Markarov <a.markarov@proton.me>
Date: Sat, 7 Feb 2026 12:48:29 +0100
Subject: [PATCH] updated Readme to include installation instructions for NixOS

---
 README.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 64 insertions(+)

diff --git a/README.md b/README.md
index b1791fe..19d3be1 100644
--- a/README.md
+++ b/README.md
@@ -33,6 +33,70 @@ sudo ninja -C build install
 
 This installs the QML plugin to `/usr/lib/qt6/qml`.
 
+### NixOS
+
+In your flake.nix file, add the following in your inputs.
+
+```nix
+inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
+    z-bar-qt = {
+        url = "github:Zacharias-Brohn/z-bar-qt/nix_packaging";
+        inputs.nixpkgs.follows = "nixpkgs";
+    };
+};
+```
+
+Below a full example of what it could look like.
+
+```nix
+{
+  inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
+    z-bar-qt = {
+        url = "github:Zacharias-Brohn/z-bar-qt/nix_packaging";
+        inputs.nixpkgs.follows = "nixpgks";
+    };
+  };
+
+  outputs =
+    inputs@{
+      nixpkgs,
+      self,
+      ...
+    }:
+    let
+      system = "x86_64-linux";
+      pkgs = import nixpkgs { inherit system; };
+    in
+    {
+      nixosConfigurations.nixos = nixpkgs.lib.nixosSystem {
+        specialArgs = {
+          inherit inputs;
+          inherit system;
+        };
+        modules = [
+          ./configuration.nix
+        ];
+      };
+    };
+}
+```
+
+Now you can add z-bar-qt as a nixpkgs in environment.systemPackages (or optionally in your homePackages).
+
+```nix
+{ pkgs, inputs, ... }:
+
+{
+    environment.systemPackages = with pkgs; [
+    inputs.z-bar-qt.packages.${system}.zshell
+    ];
+}
+```
+
+You can now run ```zshell``` to run the bar.
+
 ## Configuration
 
 Configuration is stored in `~/.config/z-bar/config.json`. Options include: