diff --git a/README.md b/README.md new file mode 100644 index 0000000..1095ad1 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# Wallpaper Sorter + +Sort wallpapers by their resolution. + +## Installation + +### Pipx + +``` +pipx install git+https://git.goatpr0n.de/public/wpsrt.git +``` + +## Usage + +```shell +wpsrt --help +Usage: wpsrt [OPTIONS] [SOURCE] [TARGET] + +Options: + --help Show this message and exit. +``` + +**SOURCE** currently defaults to `~/Pictures/wallpapers` and **TARGET** to `~/Pictures/wallpapers/by-resolution`.