feat: add talhelper package and docs

budimanjojo · Oct 19, 2024 · 7fae270 · 7fae270
1 parent 5cd36a1
commit 7fae270
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 1 deletion.
diff --git a/docs/docs/installation.md b/docs/docs/installation.md
@@ -45,6 +45,32 @@ You can get `talhelper` as [Nix Flakes](https://nixos.wiki/wiki/Flakes) from the
     ```
 
 - The package is now available at `packages.<system>.default` of the flake. You can call it in your `home.packages` or `environment.systemPackages` or `devShell` by referencing the input as `inputs.talhelper.packages.<system>.default`.
+- Additionally we provide a convenient overlay for your nixpkgs
+    ```nix
+    {
+      ...
+      pkgs = import nixpkgs {
+        overlays = [
+          inputs.talhelper.overlays.default
+        ];
+      };
+    }
+    # In any of the places you define packages
+    {
+      # Nixos
+      environment.systemPackages = with pkgs; [
+        talhelper
+      ];
+      # Home Manager
+      home.packages = with pkgs; [
+        talhelper
+      ];
+      # Flakes
+      pkgs.mkShell = with pkgs; [
+        talhelper
+      ];
+    }
+    ```
 
 ## Using Pacman
 

diff --git a/flake.nix b/flake.nix
@@ -35,7 +35,10 @@
             #   })
             # ];
           };
-          packages.default = pkgs.callPackage ./default.nix { };
+          packages = rec {
+            default = talhelper;
+            talhelper = pkgs.callPackage ./default.nix { };
+          };
           devShells.default =
             with pkgs;
             mkShell {