diff --git a/README.md b/README.md index 0712c2d..0d5b9f6 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,17 @@ A no-bloat script for getting OATH codes from a YubiKey. +# Requirements +- ykman - interfacing with YubiKeys +(`sudo pacman -S yubikey-manager` on Arch Linux - see https://wiki.archlinux.org/title/YubiKey#Management_tools) +- xclip - copying the code to the clipboard +(`sudo pacman -S xclip` on Arch Linux) +- rofi - displaying a GUI for the codes +(`sudo pacman -S rofi` on Arch Linux - see https://wiki.archlinux.org/title/Rofi) +- awk - formatting command outputs +(you should already have this installed) + + # Usage Either only download `rofi-yubikey.sh`, or clone the entire repository (`git clone https://git.solomon.tech/solomon/rofi-yubikey.git`).