Add flake usage example

This commit is contained in:
Agatha Lovelace 2023-04-03 15:16:35 +02:00
parent 0a87773ae5
commit 089835fb86
Signed by: sorceress
GPG Key ID: 01D0B3AB10CED4F8
1 changed files with 40 additions and 0 deletions

View File

@ -32,4 +32,44 @@ https://open.spotify.com/track/0ibuggkWTSDXHo25S0Qqvj?si=e4c675cbaee94c3a
After:
```
https://open.spotify.com/track/0ibuggkWTSDXHo25S0Qqvj
```
## Usage example
This repository also contains a Nix flake. It can be used in a NixOS configuration like this:
1. Add flake to inputs:
```nix
url-eater.url = "github:AgathaSorceress/url-eater";
```
2. Add package
```nix
nixpkgs.overlays = [
(final: prev: {
url-eater = url-eater.defaultPackage.${final.system};
})
];
```
3. Add a module that defines a systemd service:
```nix
{ pkgs, ... }:
let
filters = pkgs.writeText "filters.kdl" ''
category "Spotify" {
params "context@open.spotify.com" "si@open.spotify.com"
}
category "Twitter" {
params "cxt@*.twitter.com" "ref_*@*.twitter.com" "s@*.twitter.com" "t@*.twitter.com" "twclid"
}
'';
in {
systemd.user.services."url-eater" = {
description = "Clipboard URL cleanup service";
after = [ "graphical-session-pre.target" ];
wantedBy = [ "graphical-session.target" ];
script = ''
exec ${pkgs.url-eater}/bin/url-eater ${filters}
'';
};
}
```