aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFuwn <[email protected]>2024-09-13 06:05:03 -0700
committerFuwn <[email protected]>2024-09-13 06:09:51 -0700
commit11c3e7825e6785fb8f085b8c0d59c0bd8796a604 (patch)
tree27ba36e738361778f5722d44f245cc3117b65e9a /README.md
parentf6f43b6911b903a47403db44dcc0a22e07840499 (diff)
downloadpywal.nix-11c3e7825e6785fb8f085b8c0d59c0bd8796a604.tar.xz
pywal.nix-11c3e7825e6785fb8f085b8c0d59c0bd8796a604.zip
feat(nix): implement standalone mode
Diffstat (limited to 'README.md')
-rw-r--r--README.md42
1 files changed, 31 insertions, 11 deletions
diff --git a/README.md b/README.md
index 874e5e0..96d2fc6 100644
--- a/README.md
+++ b/README.md
@@ -8,25 +8,43 @@ Pywal colour schemes into any Home Manager configuration at evaluation-time.
I needed a pure (not `--impure`) Nix solution. I made a pure Nix solution. It
works well.
-## Usage
+## Installation
-### Flake
+### Standalone Home-Manager
+
+```nix
+{ pkgs, ... }:
+{
+ imports = [
+ (import (
+ pkgs.fetchFromGitHub {
+ owner = "Fuwn";
+ repo = "pywal-nix";
+ rev = "..."; # Use the current commit revision hash
+ hash = "..."; # Use the current commit sha256 hash
+ }
+ )).${builtins.currentSystem}.homeManagerModules.default
+ ];
+}
+```
+
+> You can use projects like [nurl](https://github.com/nix-community/nurl) and
+> [`nix-prefetch`](https://github.com/msteen/nix-prefetch) to simplify the
+> usage of `fetchFromGitHub`.
+
+### Flakes & Home-Manager
Add `pywal-nix` to your flake inputs.
```nix
{
- inputs = {
- pywal-nix = {
- url = "github:Fuwn/pywal-nix";
- inputs.nixpkgs.follows = "nixpkgs"; # Recommended
- };
+ inputs.pywal-nix = {
+ url = "github:Fuwn/pywal-nix";
+ inputs.nixpkgs.follows = "nixpkgs"; # Recommended
};
}
```
-### Home Manager
-
After adding `pywal-nix` to your flake inputs, consume it as a Home Manager
module.
@@ -42,8 +60,10 @@ inputs.home-manager.lib.homeManagerConfiguration {
# ...
```
-Finally, configure and access `pywal-nix` in your Home Manager configuration through
-the `pywal-nix` attribute.
+## Configuration & Usage
+
+Configure and access `pywal-nix` in your Home Manager configuration through the
+`pywal-nix` attribute.
```nix
{ pkgs, config, ... }: