Skip to content

Commit

Permalink
docs(readme): Document usage with Nix
Browse files Browse the repository at this point in the history
  • Loading branch information
bcyran committed Dec 19, 2024
1 parent ad56579 commit bc20939
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,38 @@ The binary named `timewall` has to be placed in directory in your `$PATH`, e.g.
cargo install timewall
```

### Nix
This repository contains a flake exposing a Nix package, `nixpkgs` overlay and a Home Manager module.
Add `timewall` input to your `flake.nix`:
```nix
inputs.timewall.url = "github:bcyran/timewall";
```
#### Package
```nix
environment.systemPackages = [
inputs.timewall.packages.${pkgs.system}.timewall
];
```

#### Overlay
```nix
nixpkgs.overlays = [
inputs.timewall.overlays.default
]
environment.systemPackages = [
pkgs.timewall
];
```

#### Home Manager
```nix
home.services.timewall = {
enable = true;
wallpaperPath = ./wallpaper.jpg; # optional, can be set at runtime
config = {} # optional, see the configuration section
}
```

## Usage

> [!IMPORTANT]
Expand Down

0 comments on commit bc20939

Please sign in to comment.