summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKalyan Sriram <kalyan@coderkalyan.com>2021-11-22 18:37:40 +0000
committerHubert Hirtz <hubert@hirtz.pm>2021-11-23 09:10:59 +0100
commitb46900566104c0143e06df452fb994e888b23548 (patch)
tree2d4f0e14c069fd8a4a7ff91ea9ee43d87ad66b58 /README.md
parentAdd support for CHATHISTORY TARGETS (diff)
config: replace YAML with scfg config format
This patch replaces the YAML configuration format with scfg (https://git.sr.ht/~emersion/scfg). Additionally, a few things about configuration are cleaned up: * abbreviated names are expanded (addr -> address, nick -> nickname) * negative bools switched to positive (no-tls -> tls) * independent column widths are grouped under the "pane-width" directive * implementation of default configuration values is improved * password-cmd is executed directly (with scfg field parsing) instead of with "sh -c". * on-highlight is now a file, $XDG_CONFIG_HOME/senpai/highlight by default, which can be changed with the on-highlight-path directive
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index 8ad8467..7dec286 100644
--- a/README.md
+++ b/README.md
@@ -14,12 +14,12 @@ senpai is an IRC client that works best with bouncers:
```shell
mkdir -p ~/.config/senpai
-cat <<EOF >~/.config/senpai/senpai.yaml
-addr: chat.sr.ht
-nick: senpai
-password: "my password can't be this cute (2010)"
+cat <<EOF >~/.config/senpai/senpai.scfg
+address chat.sr.ht
+nickname senpai
+password "my password can't be this cute (2010)"
# alternatively, specify a command to fetch your password:
-# password-cmd: "gopass show irc/<username>"
+# password-cmd gopass show irc/<username>
EOF
go run ./cmd/senpai
```