diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 32 |
1 files changed, 30 insertions, 2 deletions
@@ -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 |