summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
author2 * r + 2 * t <61896496+soramanew@users.noreply.github.com>2025-08-28 22:29:30 +1000
committer2 * r + 2 * t <61896496+soramanew@users.noreply.github.com>2025-08-28 22:29:30 +1000
commit0939fc6290989fb1bfaa5c02ae28d51f906010b1 (patch)
tree07956b929a7c22768dc42bc7c7fb11d782c48696 /README.md
parentreadme: add nix & release installation (diff)
downloadcaelestia-shell-0939fc6290989fb1bfaa5c02ae28d51f906010b1.tar.gz
caelestia-shell-0939fc6290989fb1bfaa5c02ae28d51f906010b1.tar.bz2
caelestia-shell-0939fc6290989fb1bfaa5c02ae28d51f906010b1.zip
readme: add home manager to configuring
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3c39ec4..6f8a1b0 100644
--- a/README.md
+++ b/README.md
@@ -214,6 +214,24 @@ git pull
All configuration options should be put in `~/.config/caelestia/shell.json`. This file is _not_ created by
default, you must create it manually.
+For NixOS users, a home manager module is also available.
+
+<details><summary><code>home.nix</code></summary>
+
+```nix
+programs.caelestia = {
+ enable = true;
+ settings = {
+ bar.status = {
+ showBattery = false;
+ };
+ paths.wallpaperDir = "~/Images";
+ };
+};
+```
+
+</details>
+
> [!NOTE]
> The example configuration only includes recommended configuration options. For more advanced customisation
> such as modifying the size of individual items or changing constants in the code, there are some other