aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFuwn <[email protected]>2024-09-12 06:49:05 -0700
committerFuwn <[email protected]>2024-09-12 06:49:05 -0700
commitfb10fa1b146b4daf87a97f3ac6a3b295ff80481e (patch)
tree516056ec2a68090d34fa4f0ac8cd625fbc4b8063 /README.md
parent0d3fc6773b32d4f4c1fc44ab0153f00e516a45cc (diff)
downloadpywal.nix-fb10fa1b146b4daf87a97f3ac6a3b295ff80481e.tar.xz
pywal.nix-fb10fa1b146b4daf87a97f3ac6a3b295ff80481e.zip
feat: special and wallpaper fields
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 30 insertions, 2 deletions
diff --git a/README.md b/README.md
index afb2236..65c2c42 100644
--- a/README.md
+++ b/README.md
@@ -55,15 +55,43 @@ the `pywal-nix` attribute.
backend = "wal"; # One of "wal", "colorz", or "colorthief"; Defaults to "wal"
};
- # Example usage to print out two colour scheme colours
+ # Example usage to print out few colours
home.packages = [
(pkgs.writeShellScriptBin "colour-scheme-sample" ''
- echo '${config.pywal-nix.colourScheme.colour0} ${config.pywal-nix.colourScheme.colour15}'
+ echo '${config.pywal-nix.colourScheme.wallpaper}'
+ echo '${config.pywal-nix.colourScheme.special.background}'
+ echo '${config.pywal-nix.colourScheme.colours.colour9}'
'')
];
}
```
+### Colour Scheme
+
+`pywal-nix`'s generated colour scheme is accessible through either the
+`colourScheme` or `colorScheme` set. Likewise, colours are accessible through
+either the `colours` or `colors` sets.
+
+The colour scheme interface generated by `pywal-nix` comes in the following shape:
+
+```typescript
+{
+ wallpaper: string
+
+ special: {
+ background: string
+ foreground: string
+ cursor: string
+ }
+
+ colours: { // or colors
+ colour0: string // or color0
+ // colour1 ... colour14 or color1 ... color15
+ colour15: string // or color15
+ }
+}
+```
+
## Pywal
This project includes multiple files from