summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author2 * r + 2 * t <61896496+soramanew@users.noreply.github.com>2025-06-28 19:14:38 +1000
committer2 * r + 2 * t <61896496+soramanew@users.noreply.github.com>2025-06-28 19:14:38 +1000
commit5f03ba33bbb58fc26d762a4bf1e87cdda82f44f0 (patch)
tree16fa417bec24f4ce3dfad0fc88d7f1d7358c3ea8
parentconfig: allow resolving paths from home (diff)
downloadcaelestia-shell-5f03ba33bbb58fc26d762a4bf1e87cdda82f44f0.tar.gz
caelestia-shell-5f03ba33bbb58fc26d762a4bf1e87cdda82f44f0.tar.bz2
caelestia-shell-5f03ba33bbb58fc26d762a4bf1e87cdda82f44f0.zip
readme: update config section
-rw-r--r--README.md61
1 files changed, 59 insertions, 2 deletions
diff --git a/README.md b/README.md
index e1dd87c..d586c06 100644
--- a/README.md
+++ b/README.md
@@ -141,8 +141,65 @@ git pull
## Configuring
-All configuration options are in `~/.config/caelestia/shell.json`. The config
-currently gets overwritten on startup however due to an upstream bug with Quickshell.
+All configuration options are in `~/.config/caelestia/shell.json`.
+
+<details><summary>Example configuration</summary>
+
+```
+{
+ "bar": {
+ "workspaces": {
+ "activeIndicator": true,
+ "activeLabel": "󰮯 ",
+ "activeTrail": false,
+ "label": " ",
+ "occupiedBg": false,
+ "occupiedLabel": "󰮯 ",
+ "rounded": true,
+ "showWindows": true,
+ "shown": 5
+ }
+ },
+ "border": {
+ "rounding": 25,
+ "thickness": 10
+ },
+ "dashboard": {
+ "mediaUpdateInterval": 500,
+ "visualiserBars": 45,
+ "weatherLocation": "10,10"
+ },
+ "launcher": {
+ "actionPrefix": ">",
+ "enableDangerousActions": false,
+ "maxShown": 8,
+ "maxWallpapers": 9
+ },
+ "lock": {
+ "maxNotifs": 5
+ },
+ "notifs": {
+ "actionOnClick": false,
+ "clearThreshold": 0.3,
+ "defaultExpireTimeout": 5000,
+ "expandThreshold": 20,
+ "expire": false
+ },
+ "osd": {
+ "hideDelay": 2000
+ },
+ "paths": {
+ "mediaGif": "root:/assets/bongocat.gif",
+ "sessionGif": "root:/assets/kurukuru.gif",
+ "wallpaperDir": "~/Pictures/Wallpapers"
+ },
+ "session": {
+ "dragThreshold": 30
+ }
+}
+```
+
+</summary>
## Credits