diff --git a/README.md b/README.md index e3986e4..9baeb5a 100644 --- a/README.md +++ b/README.md @@ -87,3 +87,69 @@ subcommands: wallpaper manage the wallpaper pip picture in picture utilities ``` + +## Configuring + +All configuration options are in `~/.config/caelestia/cli.json`. + +
Example configuration + +```json +{ + "theme": { + "enableTerm": true, + "enableHypr": true, + "enableDiscord": true, + "enableSpicetify": true, + "enableFuzzel": true, + "enableBtop": true, + "enableGtk": true, + "enableQt": true + }, + "toggles": { + "communication": { + "discord": { + "enable": true, + "match": [{ "class": "discord" }], + "command": ["discord"], + "move": true + }, + "whatsapp": { + "enable": true, + "match": [{ "class": "whatsapp" }], + "move": true + } + }, + "music": { + "spotify": { + "enable": true, + "match": [{ "class": "Spotify" }, { "initialTitle": "Spotify" }, { "initialTitle": "Spotify Free" }], + "command": ["spicetify", "watch", "-s"], + "move": true + }, + "feishin": { + "enable": true, + "match": [{ "class": "feishin" }], + "move": true + } + }, + "sysmon": { + "btop": { + "enable": true, + "match": [{ "class": "btop", "title": "btop", "workspace": { "name": "special:sysmon" } }], + "command": ["foot", "-a", "btop", "-T", "btop", "fish", "-C", "exec btop"] + } + }, + "todo": { + "todoist": { + "enable": true, + "match": [{ "class": "Todoist" }], + "command": ["todoist"], + "move": true + } + } + } +} +``` + +