diff --git a/README.md b/README.md index 5e32b0e..9584f85 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,15 @@ # xkcdlock A wrapper around screen lockers to display xkcd images + +Depending on the given arguments xkcdlock shows a random image, the latest +image or an image of choice. + +Note that 'latest' needs an internet connection for the download! +If the download fails it falls back to a specific hard-coded image + +Builtin is a function to download all images. + +Dependencies: rbash, i3lock, xrandr, awk, curl, + convert (from imagick) + +Use 'xkcdlock -h' to show the command help. diff --git a/xkcdlock b/xkcdlock index 67a9a78..cb81bd0 100755 --- a/xkcdlock +++ b/xkcdlock @@ -2,7 +2,10 @@ # xkcd_lock v1 # -# A wrapper around i3lock to display xkcd images on the lock screen +# A wrapper around screen lockers to display xkcd images on the lock screen +# +# Depending on the given arguments xkcdlock shows a random image, the latest +# image or an image of choice. # # Note that 'latest' needs an internet connection for the download! # If the download fails it falls back to a specific hard-coded image @@ -241,6 +244,8 @@ main() { l) if [[ "sway"="${OPTARG}" ]]; then LOCK_BIN="swaylock" + echo "Not yet implemented since we have no xrandr with wayland" + exit 1 fi ;; m)