feat: README.md

* feat(riot): support literal ipv6 addresses (with or without ports given)

feat(riot): -v, -4, and -6

fix(riot): do not call external binaries if possible

* feat(riot): command git

* build(riot-config): nasp.fit -> jump.nasp.fit

* feat: add bnd and nor and completions

* fix(zshrc): bnd exit when build error

* fix(tmux): press ^a twice to send ^a

* feat(riot): sshl supports specifying local port and unix sock

* feat(riot): sshr for ssh -R

* feat(riot): -o ServerAliveInterval=60

* feat(riot): conditionally RequestTTY

* feat: zsh completion for beam and beaml

* fix(frigg): ddns get ip

* fix(riot): tmux error with window number and spaces

The fix to spaces is just a workaround. Issue may still exist when
command contains spaces.

* feat(riot): ControlPersist=60s

* fix(ci): riot

* feat(tmux): prevent tmux from exiting copy mode after selection with mouse

see:
- https://www.reddit.com/r/tmux/comments/v73005/how_to_prevent_tmux_from_exiting_copy_mode_after/
- https://www.reddit.com/r/tmux/comments/1ltms6a/how_to_select_text_in_tmux_without_having_it_jump/

* feat(tmux): F12 to passthru

* fix(riot): ControlPersist 60s -> 5s

* feat: sne: search and edit

* feat(ssh): add key ip17/sep

* feat(tmux): press ESC to exit copy mode

* feat(ssh): add key sk1/piv/9a

* feat(ssh): add key sk1/fido2

* feat(ssh): add key openpgp:0x8774BF70 and remove key ip14/sep and ltp2 (asu127)

* feat(sagent): sagt gpg; improve code

* feat(sagent): check pinentry and give notes

* feat(riot): add GPG agent forwarding

Signed-off-by: Dict Xiong <me@beardic.cn>

* feat: gitconf add gpg signature; remove macos from ci

* feat(eid): add sk1 9a cert

* feat(riot): better help and fix option quite->quiet

* feat(riot): separate command options from riot options

* feat(sagt): gpg-pin and associated tests

* feat(riot): zsh completions

* fix: Apply suggestions from code review

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* fix(riot): simplify and secure

* fix: syntax

---------

Signed-off-by: Dict Xiong <me@beardic.cn>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

README.md

@@ -1 +1,58 @@
 # dotfiles
+
+My personal shell environment and command-line tools, mainly for Linux and
+NixOS systems.
+
+It includes configurations for zsh, tmux, Vim, Git, and SSH, together with a
+few utility scripts used across my machines.
+
+## Highlights
+
+- `riot`: an SSH wrapper with host presets, jump hosts, port forwarding, tmux
+  sessions, and optional GPG agent forwarding.
+- `sagt`: an SSH/GPG agent manager with support for PIV, 1Password, and
+  OpenPGP smart cards.
+- zsh aliases and completions for the bundled tools.
+- tmux and Vim configurations with plugin setup.
+- automatic updates with selectable `main`, `dev`, and `latest` channels.
+
+## Installation
+
+Quick install:
+
+```sh
+curl -fsSL https://dotfiles.cn | bash
+```
+
+Alternatively, clone the repository so the installer can be reviewed first:
+
+```sh
+git clone https://github.com/DictXiong/dotfiles.git ~/dotfiles
+~/dotfiles/install.sh -a
+```
+
+The installer adds small source/include entries to the existing zsh, tmux,
+Vim, and Git configuration files instead of replacing them entirely.
+
+## Useful commands
+
+```sh
+riot --help                 # show the SSH wrapper manual
+sagt                        # start or reuse an ssh-agent
+sagt gpg                    # use gpg-agent as SSH agent
+sagt gpg-pin                # cache the smart-card signature PIN
+dfs update                  # update dotfiles from the selected channel
+dfs config                  # edit machine-specific settings
+```
+
+## Configuration
+
+Machine-specific settings can be placed in:
+
+```text
+~/.config/dotfiles/env
+~/.config/riot-config.sh
+```
+
+This is a personal dotfiles repository. Review the configuration, SSH keys,
+and installation script before using it on another machine.